Class default

constructor

• new default(identity: default, acl: RouteACL, db: default): default

  Constructor for creating a new instance of a class.

  Parameters

  • identity: default

    The API key authentication object.
  • acl: RouteACL

    The Route Access Control List object.
  • db: default

    The Redis database object.

  Returns default

  None

Readonlyidentity

authorize

• authorize(): Promise<true | ResponseErrorType>

  Authorizes the user based on the ACL and API key information.

  Returns Promise<true | ResponseErrorType>

  A Promise that resolves to true if the user is authorized, or a ResponseErrorType object if not authorized.

StatichasPermission

• hasPermission(
      routeAcls: RouteACE[],
      userAcls: RouteACE[],
      userId: string,
  ): true | ResponseErrorType

  Checks if a user has permission based on the provided route ACLs and user ACLs.

  Parameters

  • routeAcls: RouteACE[]

    The ACLs associated with the route.
  • userAcls: RouteACE[]

    The ACLs associated with the user.
  • userId: string

    The ID of the user.

  Returns true | ResponseErrorType

  Returns true if the user has permission, otherwise returns an error object.