Provide type definition for TypeScript

[munierujp]

Could you provide type definition for TypeScript?

My idea

Add index.d.ts.

import middy from '@middy/core'

type Type = 'string' | 'int' | 'float' | 'bool'
type Config = string | [string] | [string, Type] | [string, Type, string]

export interface Options {
  names: Record<string, Config>
  cache?: boolean
  cacheExpiryInMillis?: number
  setToContext?: boolean
}

declare const env: middy.Middleware<Options, any, any>

export default env

Then, add types field to pacakge.json.

{
  "types": "index.d.ts"
}

See also

• https://www.typescriptlang.org/docs/handbook/declaration-files/introduction.html
• https://github.com/middyjs/middy/blob/master/packages/db-manager/index.d.ts

[vicary]

I don't think context can be typed for middy 2.x because it is hard-coded as LambdaContext, only the request event can be typed.

I think this requires a minor update to add an option to distribute into a new event property, for example event.env, instead.

[chrisandrews7]

Please feel free to raise a PR.