@malijs/apikey

Api key authorization metadata middleware for Mali

Usage no npm install needed!

<script type="module">
  import malijsApikey from 'https://cdn.skypack.dev/@malijs/apikey';
</script>

README

@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

Param Type Description
options Options
options.keyField String Optional key field within the authorization value to look for. Default: "apikey"
options.error String | Object | function optional 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"
fn function The 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