Function getPayload

  • getPayload<Payload extends object = object>(): Payload

    Retrieves the payload from the current PayloadContextService context. Returns null if no context is available. Logs the operation if logging is enabled.

    Type Parameters

    • Payload extends object = object

      The type of the payload object, defaults to a generic object.

    Returns Payload

    the payload data from the context, or null if no context exists.

    Example

    const payload = await getPayload<{ id: number }>();
    console.log(payload); // { id: number } or null

Settings

Member Visibility