Type Alias ScopedEndpointFactory<TRoles>

Type Declaration

• authorize: function

  • authorize<TSchema extends SchemaBuilder<any, any, any, any, any>>(
        principalSchema: TSchema,
        ...roles: TRoles[],
    ): ScopedEndpointFactoryMethods<InferType<TSchema>, TRoles>

    Returns a new resource factory where all endpoints inherit the given authorization requirements.

    • authorize(principalSchema, ...roles) — typed principal
    • authorize(...roles) — untyped principal

    Type Parameters

    • TSchema extends SchemaBuilder<any, any, any, any, any>

    Parameters

    • principalSchema: TSchema
    • ...roles: TRoles[]

    Returns ScopedEndpointFactoryMethods<InferType<TSchema>, TRoles>

  • authorize(...roles: TRoles[]): ScopedEndpointFactoryMethods<unknown, TRoles>

    Parameters

    • ...roles: TRoles[]

    Returns ScopedEndpointFactoryMethods<unknown, TRoles>

• public: function

  • public(): ScopedEndpointFactoryMethods<TRoles>

    Returns factory methods where all endpoints are public (no auth).

    Returns ScopedEndpointFactoryMethods<TRoles>