Class SentinelIntervalAutomationWrapper<T>

Type Parameters

Hierarchy (View Summary)

Constructors

constructor

Properties

payload loaderFactory

Accessors

frequencyMillis remaining

Methods

checkEnd consumeRemaining dataHash getErrors getValid next schema setRemaining setStart validate as load parse setLoaderFactory tryParse unwrap unwrapSinglePayload wrap wrappedMap

Constructors

constructor

  • new SentinelIntervalAutomationWrapper<
        T extends
            DeepRestrictToStringKeys<
                {
                    end?: number;
                    frequency?: number;
                    frequencyUnits?: "second"
                    | "minute"
                    | "hour"
                    | "day";
                    remaining?: number;
                    schema: "network.xyo.automation.interval";
                    start: number;
                    type: "interval";
                },
            > = DeepRestrictToStringKeys<
            {
                end?: number;
                frequency?: number;
                frequencyUnits?: "second"
                | "minute"
                | "hour"
                | "day";
                remaining?: number;
                schema: "network.xyo.automation.interval";
                start: number;
                type: "interval";
            },
        >,
    >(
        payload: T,
    ): SentinelIntervalAutomationWrapper<T>

  • Type Parameters

    • T extends DeepRestrictToStringKeys<
          {
              end?: number;
              frequency?: number;
              frequencyUnits?: "second"
              | "minute"
              | "hour"
              | "day";
              remaining?: number;
              schema: "network.xyo.automation.interval";
              start: number;
              type: "interval";
          },
      > = DeepRestrictToStringKeys<
          {
              end?: number;
              frequency?: number;
              frequencyUnits?: "second"
              | "minute"
              | "hour"
              | "day";
              remaining?: number;
              schema: "network.xyo.automation.interval";
              start: number;
              type: "interval";
          },
      >

    Parameters

    • payload: T

    Returns SentinelIntervalAutomationWrapper<T>

Properties

payload

payload: T

Protected StaticloaderFactory

loaderFactory: null | PayloadLoaderFactory

Accessors

ProtectedfrequencyMillis

  • get frequencyMillis(): number

  • Returns number

Protectedremaining

  • get remaining(): number

  • Returns number

Methods

ProtectedcheckEnd

  • checkEnd(): void

  • Returns void

ProtectedconsumeRemaining

  • consumeRemaining(count?: number): void

  • Parameters

    • Optionalcount: number

    Returns void

dataHash

  • dataHash(): Promise<Lowercase<string>>

  • Returns Promise<Lowercase<string>>

getErrors

  • getErrors(): Promise<Error[]>

  • Returns Promise<Error[]>

getValid

  • getValid(): Promise<boolean>

  • Returns Promise<boolean>

next

  • next(): this

  • Returns this

schema

  • schema(): string

  • Returns string

ProtectedsetRemaining

  • setRemaining(remaining: number): void

  • Parameters

    • remaining: number

    Returns void

ProtectedsetStart

  • setStart(start: number): void

  • Parameters

    • start: number

    Returns void

validate

  • validate(): Promise<Error[]>

  • Returns Promise<Error[]>

Staticas

Staticload

  • load(
        address: Lowercase<string>,
    ): Promise<
        null
        | PayloadDataWrapper<DeepRestrictToStringKeys<{ schema: string }>>,
    >

  • Parameters

    • address: Lowercase<string>

    Returns Promise<null | PayloadDataWrapper<DeepRestrictToStringKeys<{ schema: string }>>>

Staticparse

  • parse<T extends DeepRestrictToStringKeys<{ schema: string }>>(
        payload?: unknown,
    ): undefined | PayloadDataWrapper<T>

  • Type Parameters

    Parameters

    • Optionalpayload: unknown

    Returns undefined | PayloadDataWrapper<T>

StaticsetLoaderFactory

StatictryParse

  • tryParse<T extends DeepRestrictToStringKeys<{ schema: string }>>(
        obj: unknown,
    ): undefined | PayloadDataWrapper<T>

  • Type Parameters

    Parameters

    • obj: unknown

    Returns undefined | PayloadDataWrapper<T>

Staticunwrap

StaticunwrapSinglePayload

Staticwrap

  • wrap<T extends DeepRestrictToStringKeys<{ schema: string }>>(
        payload?: T | PayloadDataWrapper<T>,
    ): PayloadDataWrapper<T>

  • Type Parameters

    Parameters

    • Optionalpayload: T | PayloadDataWrapper<T>

    Returns PayloadDataWrapper<T>

StaticwrappedMap

  • wrappedMap<T extends DeepRestrictToStringKeys<{ schema: string }>>(
        payloads: (T | PayloadDataWrapper<T>)[],
    ): Promise<Record<string, PayloadDataWrapper<T>>>

  • Type Parameters

    Parameters

    • payloads: (T | PayloadDataWrapper<T>)[]

    Returns Promise<Record<string, PayloadDataWrapper<T>>>

Settings

Member Visibility

On This Page

Constructors
Properties
Accessors
Methods