Class NetworkPayloadWrapper

Hierarchy (View Summary)

Constructors

constructor

Properties

payload loaderFactory

Accessors

archivists bridges diviners sentinels

Methods

dataHash filterNodesByType getErrors getValid schema validate as known load parse setLoaderFactory tryParse unwrap unwrapSinglePayload wrap wrappedMap

Constructors

Protectedconstructor

  • new NetworkPayloadWrapper(
        payload: DeepRestrictToStringKeys<
            {
                name?: string;
                nodes?: {
                    docs?: string;
                    name?: string;
                    schema: "network.xyo.network.node";
                    slug: string;
                    type: NetworkNodeType;
                    uri: string;
                    web?: string;
                }[];
                schema: "network.xyo.network";
                slug: string;
            },
        >,
    ): NetworkPayloadWrapper

  • Parameters

    • payload: DeepRestrictToStringKeys<
          {
              name?: string;
              nodes?: {
                  docs?: string;
                  name?: string;
                  schema: "network.xyo.network.node";
                  slug: string;
                  type: NetworkNodeType;
                  uri: string;
                  web?: string;
              }[];
              schema: "network.xyo.network";
              slug: string;
          },
      >

    Returns NetworkPayloadWrapper

Properties

payload

payload: DeepRestrictToStringKeys<
    {
        name?: string;
        nodes?: {
            docs?: string;
            name?: string;
            schema: "network.xyo.network.node";
            slug: string;
            type: NetworkNodeType;
            uri: string;
            web?: string;
        }[];
        schema: "network.xyo.network";
        slug: string;
    },
>

Protected StaticloaderFactory

loaderFactory: null | PayloadLoaderFactory

Accessors

archivists

  • get archivists(): | undefined
    | {
        docs?: string;
        name?: string;
        schema: "network.xyo.network.node";
        slug: string;
        type: NetworkNodeType;
        uri: string;
        web?: string;
    }[]

  • Returns
        | undefined
        | {
            docs?: string;
            name?: string;
            schema: "network.xyo.network.node";
            slug: string;
            type: NetworkNodeType;
            uri: string;
            web?: string;
        }[]

bridges

  • get bridges(): | undefined
    | {
        docs?: string;
        name?: string;
        schema: "network.xyo.network.node";
        slug: string;
        type: NetworkNodeType;
        uri: string;
        web?: string;
    }[]

  • Returns
        | undefined
        | {
            docs?: string;
            name?: string;
            schema: "network.xyo.network.node";
            slug: string;
            type: NetworkNodeType;
            uri: string;
            web?: string;
        }[]

diviners

  • get diviners(): | undefined
    | {
        docs?: string;
        name?: string;
        schema: "network.xyo.network.node";
        slug: string;
        type: NetworkNodeType;
        uri: string;
        web?: string;
    }[]

  • Returns
        | undefined
        | {
            docs?: string;
            name?: string;
            schema: "network.xyo.network.node";
            slug: string;
            type: NetworkNodeType;
            uri: string;
            web?: string;
        }[]

sentinels

  • get sentinels(): | undefined
    | {
        docs?: string;
        name?: string;
        schema: "network.xyo.network.node";
        slug: string;
        type: NetworkNodeType;
        uri: string;
        web?: string;
    }[]

  • Returns
        | undefined
        | {
            docs?: string;
            name?: string;
            schema: "network.xyo.network.node";
            slug: string;
            type: NetworkNodeType;
            uri: string;
            web?: string;
        }[]

Methods

dataHash

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

  • Returns Promise<Lowercase<string>>

filterNodesByType

  • filterNodesByType(
        type: NetworkNodeType,
    ):
        | undefined
        | {
            docs?: string;
            name?: string;
            schema: "network.xyo.network.node";
            slug: string;
            type: NetworkNodeType;
            uri: string;
            web?: string;
        }[]

  • Parameters

    Returns
        | undefined
        | {
            docs?: string;
            name?: string;
            schema: "network.xyo.network.node";
            slug: string;
            type: NetworkNodeType;
            uri: string;
            web?: string;
        }[]

getErrors

  • getErrors(): Promise<Error[]>

  • Returns Promise<Error[]>

getValid

  • getValid(): Promise<boolean>

  • Returns Promise<boolean>

schema

  • schema(): string

  • Returns string

validate

  • validate(): Promise<Error[]>

  • Returns Promise<Error[]>

Staticas

Staticknown

  • known(
        hash: Lowercase<string>,
    ): Promise<
        | undefined
        | DeepRestrictToStringKeys<
            {
                name?: string;
                nodes?: {
                    docs?: string;
                    name?: string;
                    schema: "network.xyo.network.node";
                    slug: string;
                    type: NetworkNodeType;
                    uri: string;
                    web?: string;
                }[];
                schema: "network.xyo.network";
                slug: string;
            },
        >,
    >

  • Parameters

    • hash: Lowercase<string>

    Returns Promise<
        | undefined
        | DeepRestrictToStringKeys<
            {
                name?: string;
                nodes?: {
                    docs?: string;
                    name?: string;
                    schema: "network.xyo.network.node";
                    slug: string;
                    type: NetworkNodeType;
                    uri: string;
                    web?: string;
                }[];
                schema: "network.xyo.network";
                slug: string;
            },
        >,
    >

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