Class AuditEventsGet

Hierarchy

Constructors

constructor

Properties

_inputType _outputType container handle timeout?

Constructors

constructor

  • Parameters

    • container: {
          audit: Audit;
      }

    Returns AuditEventsGet

Properties

Protected _inputType

_inputType: ClientRPCRequestParams<{
    awaitFutureEvents?: boolean;
    limit?: number;
    order?: "asc" | "desc";
    paths: TopicSubPath[];
    seek?: number | AuditEventIdEncoded;
    seekEnd?: number | AuditEventIdEncoded;
}>

Type declaration

Protected _outputType

_outputType: ClientRPCResponseResult<AuditEventSerialized>

Protected container

container: {
    audit: Audit;
}

Type declaration

handle

handle: ((__namedParameters, _cancel, _meta, ctx) => AsyncGenerator<ClientRPCResponseResult<AuditEventSerialized>, any, unknown>) = ...

Type declaration

    • (__namedParameters, _cancel, _meta, ctx): AsyncGenerator<ClientRPCResponseResult<AuditEventSerialized>, any, unknown>

    • Parameters

      • __namedParameters: {
            awaitFutureEvents?: boolean;
            limit?: number;
            order?: "asc" | "desc";
            seek?: number | AuditEventIdEncoded;
            seekEnd?: number | AuditEventIdEncoded;
        } & {
            metadata?: Partial<{
                timeout: null | number;
            }> & Partial<{
                authorization: string;
            }> & JSONObject;
        } & {
            paths: TopicSubPath[];
        }
      • _cancel: ((reason?) => void)
          • (reason?): void

          • Parameters

            • Optional reason: any

            Returns void

      • _meta: Record<string, JSONValue>
      • ctx: ContextTimed

      Returns AsyncGenerator<ClientRPCResponseResult<AuditEventSerialized>, any, unknown>

Optional timeout

timeout?: number

This is the timeout used for the handler. If it is not set then the default timeout time for the RPCServer is used.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc