Interface BaseJobWorkerContext<J>

Context object for base service methods.

interface BaseJobWorkerContext<J extends Job = Job> {
    isSilent?: boolean;
    job: J;
    requestId?: string;
    transaction?: EntityManager;
    user: CurrentUser;
    isGranted(
        action: string,
        actionScopes?: ActionScopes | ActionScopesArray,
    ): boolean;
    validateAccess(
        action: string,
        scopes?: ActionScopes | ActionScopesArray,
    ): void;
}

Type Parameters

Hierarchy (View Summary)

Properties

isSilent? job requestId? transaction? user

Methods

isGranted validateAccess

Properties

OptionalisSilent

isSilent?: boolean

Make the request silent, meaning no notifications and actions will be sent.

job

job: J

OptionalrequestId

requestId?: string

An optional request ID.

Optionaltransaction

transaction?: EntityManager

Check permission and throw AccessDenied error if user doesn't have permission

Param: action

action string

Param: actionScopes

scopes where action was executed

Throws

AccessDenied error if the user doesn't have the permission

user

user: CurrentUser

The current user making the request.

Methods

isGranted

  • isGranted(
        action: string,
        actionScopes?: ActionScopes | ActionScopesArray,
    ): boolean

    Checks if the user has permission to perform the specified action.

    Parameters

    • action: string

      The action to check permission for.

    • OptionalactionScopes: ActionScopes | ActionScopesArray

      Optional scopes to check permission against.

    Returns boolean

    True if the user has permission, false otherwise.

validateAccess

  • validateAccess(action: string, scopes?: ActionScopes | ActionScopesArray): void

    Check permission and throw AccessDenied error if user doesn't have permission

    Parameters

    • action: string

      action string

    • Optionalscopes: ActionScopes | ActionScopesArray

      scopes where action was executed

    Returns void

    Throws

    AccessDenied error if the user doesn't have the permission

Settings

Member Visibility

On This Page

Properties
Methods