0.2.0 • Published 5 years ago

@malijs/apikey v0.2.0

Weekly downloads
1
License
Apache-2.0
Repository
github
Last release
5 years ago

@malijs/apikey

Mali API key metadata authorization middleware

npm version build status

API

@malijs/apikey

Mali API key authorization metadata middleware. If the call has metadata with "authorization" string property with "apikey " then specified function is called

ParamTypeDescription
optionsOptions
options.keyFieldStringOptional key field within the authorization value to look for. Default: "apikey"
options.errorString | Object | functionoptional Error creation options. If String the message for Error to throw in case authorization is not present. If Object the error options with message, code, and metadata properties. See create-grpc-error module. If Function a function with signature (ctx) called to create an error. Must return an Error instanse. Default: "Not Authorized"
fnfunctionThe middleware function to execute with signature (key, ctx, next)

Example

const apikey = require('@malijs/apikey')

app.use(apikey(async (key, ctx, next) => {
  console.log(key)
  await next()
})

License

Apache-2.0