Class SentinelRunner

Hierarchy

  • SentinelRunner

Constructors

  • Parameters

    • sentinel: SentinelModule<SentinelParams<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: "network.xyo.node.sentinel";
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<SchemaFields & PayloadFields & {
          archivist?: ArchivistModuleConfig;
          name?: string;
          paging?: Record<string, {
              size?: number;
          }>;
          schema: string;
          security?: {
              allowAnonymous?: boolean;
              allowed?: Record<string, (string | CosigningAddressSet)[]>;
              disallowed?: Record<string, string[]>;
          };
          storeQueries?: boolean;
      } & Omit<{
          archivists?: string[];
          schema: string;
      }, "schema"> & {
          schema: "network.xyo.node.sentinel";
          witnesses?: string[];
      } & {
          schema: string;
      }, "schema">, "schema"> & {
          schema: string;
      }, "schema">, undefined>, SentinelModuleEventData>
    • Optional automations: SentinelAutomationPayload[]
    • Optional onTriggerResult: OnSentinelRunnerTriggerResult

    Returns SentinelRunner

Properties

_automations: Record<string, SentinelAutomationPayload>
onTriggerResult: undefined | OnSentinelRunnerTriggerResult
sentinel: SentinelModule<SentinelParams<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: "network.xyo.node.sentinel";
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<SchemaFields & PayloadFields & {
    archivist?: ArchivistModuleConfig;
    name?: string;
    paging?: Record<string, {
        size?: number;
    }>;
    schema: string;
    security?: {
        allowAnonymous?: boolean;
        allowed?: Record<string, (string | CosigningAddressSet)[]>;
        disallowed?: Record<string, string[]>;
    };
    storeQueries?: boolean;
} & Omit<{
    archivists?: string[];
    schema: string;
}, "schema"> & {
    schema: "network.xyo.node.sentinel";
    witnesses?: string[];
} & {
    schema: string;
}, "schema">, "schema"> & {
    schema: string;
}, "schema">, undefined>, SentinelModuleEventData>
timeoutId?: Timer
trigger: any

Accessors

  • get next(): any
  • Returns any

Methods

  • Parameters

    Returns Promise<string>

  • Parameters

    • hash: string

    Returns void

  • Parameters

    • hash: string
    • Optional restart: boolean

    Returns Promise<void>

  • Returns void

  • Returns Promise<void>

  • Returns Promise<void>

  • Returns void

  • Parameters

    Returns Promise<void>

Generated using TypeDoc