@gotamedia/utils v0.1.2
Gota Media Utils
Set of Utils helpers for NodeJs Runtime.
Usage
npm install @gotamedia/utils
import { logError } from "@gotamedia/utils/logError"
const handler = () => {
logError(new Error("Oops!"))
}
Utils
Available utils:
- logError
- getErrorTrace
- sourceMapSupport
Available methods:
logError()
A helper function to log errors with traces
param | type | default | required | description |
---|---|---|---|---|
first | Error | undefined | Error object to parse and log with traces | |
second | any | undefined | Any additional info that will be added to the output under ìnfo property |
Example:
import logError from "@gotamedia/utils/logError"
const handler = async () => {
const trakingId = "123-321"
try {
...
const response = await fetch(`www.example.com/id/${trakingId}`)
...
} catch (error) {
logError(
error,
{
trakingId: trakingId,
message: "Oops! Something went wrong here.",
reason: "Failed to do something because of something"
}
)
}
}
getErrorTrace()
A helper function to extract trace from Error object
param | type | default | required | description |
---|---|---|---|---|
first | Error | new Error() | Error object to extract trace from |
Example:
import { getErrorTrace } from "@gotamedia/utils/getErrorTrace"
const handler = async () => {
try {
...
} catch (error) {
const trace = getErrorTrace(error)
console.log(trace)
}
}
sourceMapSupport
A helper util to parse source-maps from your "un-minified" Lambda code if you bundle and minify your Lambda
NOTE: If you want to support source-map this import needs to be the first import statement in your entry file.
Example:
import "@gotamedia/utils/sourceMapSupport"
const handler = async () => {
...
}
Contributing
Trunk based development
This project uses a trunk based development workflow.
NOTE:
master
is the trunk branch
Conventional commits
This project works with conventional commits.
Contribute
- Pull latest from develop.
- Branch out a new branch.
- Commit and push your awesome code.
- Open a pull request so we can approve your awesome code.
Publish
Any time you push to origin master branch, a pipeline will be automatically triggered and it will build the package for you. The pipeline will bump the version for you automatically and tag the package.
NOTE: NO MANUAL TAGGING
Then it will generate and update the CHANGELOG depends on your pushed commits.
License
MIT