Interface CustomSentinelModule<TParams, TEvents>

interface CustomSentinelModule<
    TParams extends SentinelParams = SentinelParams,
    TEvents extends
        SentinelModuleEventData<SentinelModule<TParams>> = SentinelModuleEventData<
        SentinelModule<TParams>,
    >,
> {
    address: Lowercase<string>;
    config: TParams["config"];
    eventData: TEvents;
    id: string;
    modName?: string;
    params: TParams;
    previousHash: () => Promisable<undefined | string>;
    queries: string[];
    query: <
        T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
        TConf extends ModuleConfig<void, void> = ModuleConfig<void, void>,
    >(
        query: T,
        payloads?: Payload[],
        queryConfig?: TConf,
    ) => Promisable<ModuleQueryResult<Payload, ModuleError, BoundWitness>>;
    queryable: <
        T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
        TConf extends ModuleConfig<void, void> = ModuleConfig<void, void>,
    >(
        query: T,
        payloads?: Payload[],
        queryConfig?: TConf,
    ) => Promisable<boolean>;
    start?: () => Promisable<boolean>;
    stop?: () => Promisable<boolean>;
    clearListeners(eventNames: keyof TEvents | (keyof TEvents)[]): void;
    emit<TEventName extends string | number | symbol>(
        eventName: TEventName,
        eventArgs: TEvents[TEventName],
    ): Promise<void>;
    emitSerial<TEventName extends string | number | symbol>(
        eventName: TEventName,
        eventArgs: TEvents[TEventName],
    ): Promise<void>;
    listenerCount(eventNames: keyof TEvents | (keyof TEvents)[]): number;
    off<TEventName extends string | number | symbol>(
        eventNames: TEventName | TEventName[],
        listener: EventListener<TEvents[TEventName]>,
    ): void;
    offAny(listener: Promise<void> | EventAnyListener<EventArgs>): void;
    on<TEventName extends string | number | symbol>(
        eventNames: TEventName | TEventName[],
        listener: EventListener<TEvents[TEventName]>,
    ): EventUnsubscribeFunction;
    onAny(listener: EventAnyListener): EventUnsubscribeFunction;
    once<TEventName extends string | number | symbol>(
        eventName: TEventName,
        listener: EventListener<TEvents[TEventName]>,
    ): EventUnsubscribeFunction;
}

Type Parameters

Hierarchy (View Summary)

Properties

address config eventData id modName? params previousHash queries query queryable start? stop?

Methods

clearListeners emit emitSerial listenerCount off offAny on onAny once

Properties

address

address: Lowercase<string>

config

config: TParams["config"]

eventData

eventData: TEvents

id

id: string

OptionalmodName

modName?: string

params

params: TParams

previousHash

previousHash: () => Promisable<undefined | string>

queries

queries: string[]

query

query: <
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConf extends ModuleConfig<void, void> = ModuleConfig<void, void>,
>(
    query: T,
    payloads?: Payload[],
    queryConfig?: TConf,
) => Promisable<ModuleQueryResult<Payload, ModuleError, BoundWitness>>

queryable

queryable: <
    T extends UnsignedQueryBoundWitness = UnsignedQueryBoundWitness,
    TConf extends ModuleConfig<void, void> = ModuleConfig<void, void>,
>(
    query: T,
    payloads?: Payload[],
    queryConfig?: TConf,
) => Promisable<boolean>

Optionalstart

start?: () => Promisable<boolean>

Optionalstop

stop?: () => Promisable<boolean>

Methods

clearListeners

  • clearListeners(eventNames: keyof TEvents | (keyof TEvents)[]): void

    Parameters

    Returns void

emit

  • emit<TEventName extends string | number | symbol>(
        eventName: TEventName,
        eventArgs: TEvents[TEventName],
    ): Promise<void>

    Type Parameters

    • TEventName extends string | number | symbol

    Parameters

    Returns Promise<void>

emitSerial

listenerCount

  • listenerCount(eventNames: keyof TEvents | (keyof TEvents)[]): number

    Parameters

    Returns number

off

offAny

on

onAny

once

Settings

Member Visibility

On This Page

Properties
Methods