Class API<Schema, ExtensionFn>

constructor

• new API<Schema, ExtensionFn>(schema, extensionFn, config?): API<Schema, ExtensionFn>

• Type Parameters

  • Schema extends SchemaInput = any
  • ExtensionFn extends ApiExtensionFunction = ApiExtensionFunction

  Parameters

  • schema: Schema
  • extensionFn: ExtensionFn
  • config: APIConfig = DEFAULT_CONFIG

  Returns API<Schema, ExtensionFn>

app

client

config

ReadonlyextensionFn

Readonlyschema

auth

• auth(handler): void

• Parameters

  • handler: ((client: Client) => JsonMiddleware)
    • • (client): JsonMiddleware

      • Parameters

        • client: Client

        Returns JsonMiddleware

  Returns void

   type Return = (
       // Return a status code and a function that will be called with the body of the response
       [statusCode: number, bodyFunction: (body: any) => any] |
       // Return a function that will be called with the body of the response
       (body: any) => any
   )
  Copy

  Description

  Add a middleware to the API that will help authorize requests

  Example

   api.auth(client => async (req, res, next) => {
     const unauthorized = () => [401, () => ({error: 'Unauthorized'})];
     const isOp = api.createOpChecker(req);
     const token = req.headers['authorization'];
     const {path} = api.describeRequest(req)
     // Do not use a users email as your auth token, just an example
     const user: Schema['users'] = await client.query('select * from users where email = $1', [token]).then(({rows}) => rows[0]);
     if (!user) return unauthorized();
     if (isOp('users/:id', 'GET')) {
       if (user.id.toString() !== path.split('/').pop())
         return unauthorized();
     }
   });
  Copy

configure

• configure(config): void

• Parameters

  • config: APIConfig

  Returns void

  Description

  Configure the API

  Example

  api.configure({port: 3001});
  Copy

createOpChecker

• createOpChecker(req): ((route: (keyof Schema extends string
      ? keyof ReturnType<ExtensionFn> | string & keyof Schema | `${string & keyof Schema}/:id`
      : never) | (keyof Schema extends string
      ? keyof ReturnType<ExtensionFn> | string & keyof Schema | `${string & keyof Schema}/:id`
      : never)[], method?:
      | undefined
      | "GET"
      | "HEAD"
      | "POST"
      | "PUT"
      | "DELETE"
      | "CONNECT"
      | "OPTIONS"
      | "TRACE"
      | "PATCH"
      | (
          | "GET"
          | "HEAD"
          | "POST"
          | "PUT"
          | "DELETE"
          | "CONNECT"
          | "OPTIONS"
          | "TRACE"
          | "PATCH")[]) => boolean)

• Parameters

  • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

  Returns ((route: (keyof Schema extends string
      ? keyof ReturnType<ExtensionFn> | string & keyof Schema | `${string & keyof Schema}/:id`
      : never) | (keyof Schema extends string
      ? keyof ReturnType<ExtensionFn> | string & keyof Schema | `${string & keyof Schema}/:id`
      : never)[], method?:
      | undefined
      | "GET"
      | "HEAD"
      | "POST"
      | "PUT"
      | "DELETE"
      | "CONNECT"
      | "OPTIONS"
      | "TRACE"
      | "PATCH"
      | (
          | "GET"
          | "HEAD"
          | "POST"
          | "PUT"
          | "DELETE"
          | "CONNECT"
          | "OPTIONS"
          | "TRACE"
          | "PATCH")[]) => boolean)

  • • (route, method?): boolean

    • Parameters

      • route: (keyof Schema extends string
            ? keyof ReturnType<ExtensionFn> | string & keyof Schema | `${string & keyof Schema}/:id`
            : never) | (keyof Schema extends string
            ? keyof ReturnType<ExtensionFn> | string & keyof Schema | `${string & keyof Schema}/:id`
            : never)[]
      • method:
            | undefined
            | "GET"
            | "HEAD"
            | "POST"
            | "PUT"
            | "DELETE"
            | "CONNECT"
            | "OPTIONS"
            | "TRACE"
            | "PATCH"
            | (
                | "GET"
                | "HEAD"
                | "POST"
                | "PUT"
                | "DELETE"
                | "CONNECT"
                | "OPTIONS"
                | "TRACE"
                | "PATCH")[] = ...

      Returns boolean

  Description

  • Create a function that checks if the request matches the route and method.
  • Useful for middleware.

  Example

  const isOp = api.createOpChecker(req);
  
  if (isOp('users/:id', 'GET')) {
    // Do something
  }
  Copy

describeRequest

• describeRequest(req): {
      method: string;
      path: string;
      route: undefined | string;
  }

• Parameters

  • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

  Returns {
      method: string;
      path: string;
      route: undefined | string;
  }

  • method: string

  • path: string

  • route: undefined | string

  Description

  Describe the operation of a request

  Example

  const {path, method} =api.describeReqOp(req);
  Copy

hasRoute

• hasRoute(path, method): any

• Parameters

  • path: string
  • method:
        | "GET"
        | "HEAD"
        | "POST"
        | "PUT"
        | "DELETE"
        | "CONNECT"
        | "OPTIONS"
        | "TRACE"
        | "PATCH"

  Returns any

  Description

  Check if the API has a route

  Example

  api.hasRoute('/users');
  Copy

isOp

• isOp(req, route, method?): boolean

• Parameters

  • req: Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>
  • route: (keyof Schema extends string
        ? keyof ReturnType<ExtensionFn> | string & keyof Schema | `${string & keyof Schema}/:id`
        : never) | (keyof Schema extends string
        ? keyof ReturnType<ExtensionFn> | string & keyof Schema | `${string & keyof Schema}/:id`
        : never)[]
  • method:
        | "GET"
        | "HEAD"
        | "POST"
        | "PUT"
        | "DELETE"
        | "CONNECT"
        | "OPTIONS"
        | "TRACE"
        | "PATCH"
        | (
            | "GET"
            | "HEAD"
            | "POST"
            | "PUT"
            | "DELETE"
            | "CONNECT"
            | "OPTIONS"
            | "TRACE"
            | "PATCH")[] = ...

  Returns boolean

  Description

  • Check if the request matches the route and method.
  • Useful for middleware.

  Example

  api.isOp(req, 'users', 'GET');
  Copy

relpath

• relpath(path): string

• Parameters

  • path: string | Request<ParamsDictionary, any, any, ParsedQs, Record<string, any>>

  Returns string

  Description

  Remove the API's prefix from a path

  Example

  api.relpath(req);
  // '/api/users' --> 'users'
  Copy

start

• start(): Promise<undefined | Error>

• Returns Promise<undefined | Error>

  Description

  Start the API Server

  Example

  api.start().then((err) => {
    if (err) {
      console.error(err);
    }
    else {
      console.log(`API is running on port ${api.config.port}`);
    }
  });
  Copy