Class HookBeforeListContext<S, N>

Type Parameters

Hierarchy

Constructors

constructor

Properties

_filter _projection realCollection

Accessors

caller collection dataSource filter projection

Methods

throwError throwForbiddenError throwValidationError

Constructors

constructor

Properties

Protected _filter

_filter: PaginatedFilter

Protected _projection

_projection: Projection

Protected realCollection

realCollection: Collection

Accessors

caller

  • get caller(): Readonly<Caller>

  • Returns Readonly<Caller>

collection

  • get collection(): default<S, N>

  • Returns default<S, N>

dataSource

  • get dataSource(): default<S>

  • Returns default<S>

filter

  • get filter(): Readonly<TPaginatedFilter<S, N>>

  • Returns Readonly<TPaginatedFilter<S, N>>

projection

  • get projection(): readonly TFieldName<S, N>[]

  • Returns readonly TFieldName<S, N>[]

Methods

throwError

  • Stop hooks execution and send error to the UI

    Example

    .throwError('My error message');

    Parameters

    • message: string

      the error message

    Returns never

throwForbiddenError

  • Stop hooks execution and send Forbidden error to the UI

    Example

    .throwForbiddenError('My forbidden error message');

    Parameters

    • message: string

      the forbidden error message

    Returns never

throwValidationError

  • Stop hooks execution and send Validation error to the UI

    Example

    .throwValidationError('My validation error message');

    Parameters

    • message: string

      the validation error message

    Returns never

Settings

Member Visibility

Theme