Class DomainPayloadWrapper<T>

Type Parameters

T extends DomainPayload = DomainPayload

Hierarchy (View Summary)

PayloadWrapper<T>
- DomainPayloadWrapper

Constructors

`Protected`constructor

new DomainPayloadWrapper<
    T extends
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [key: string]: { huri: string; name?: string } };
                networks?: {
                    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;
                }[];
                schema: "network.xyo.domain";
            },
        > = DeepRestrictToStringKeys<
        {
            additional?: string[];
            aliases?: { [key: string]: { huri: string; name?: string } };
            networks?: {
                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;
            }[];
            schema: "network.xyo.domain";
        },
    >,
>(
    payload: T,
): DomainPayloadWrapper<T>
Type Parameters
- T extends DeepRestrictToStringKeys<
      {
          additional?: string[];
          aliases?: { [key: string]: { huri: string; name?: string } };
          networks?: {
              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;
          }[];
          schema: "network.xyo.domain";
      },
  > = DeepRestrictToStringKeys<
      {
          additional?: string[];
          aliases?: { [key: string]: { huri: string; name?: string } };
          networks?: {
              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;
          }[];
          schema: "network.xyo.domain";
      },
  >
Parameters
- payload: T
Returns DomainPayloadWrapper<T>
Inherited from PayloadWrapper.constructor
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:29

Properties

`Optional`aliases

aliases?: null | FetchedAlias[]

payload

payload: T

`Protected` `Static`loaderFactory

loaderFactory: null | PayloadLoaderFactory

Methods

dataHash

dataHash(): Promise<Lowercase<string>>
Returns Promise<Lowercase<string>>
Inherited from PayloadWrapper.dataHash
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:20

fetch

fetch(networkSlug?: Lowercase<string>): Promise<void>
Parameters
- OptionalnetworkSlug: Lowercase<string>
Returns Promise<void>
- Defined in packages/core-payload-plugins/packages/domain/dist/neutral/index.d.ts:176

fetchAliases

fetchAliases(networkSlug?: Lowercase<string>): Promise<void>
Parameters
- OptionalnetworkSlug: Lowercase<string>
Returns Promise<void>
- Defined in packages/core-payload-plugins/packages/domain/dist/neutral/index.d.ts:177

getErrors

getErrors(): Promise<Error[]>
Returns Promise<Error[]>
Inherited from PayloadWrapper.getErrors
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:21

getValid

getValid(): Promise<boolean>
Returns Promise<boolean>
Inherited from PayloadWrapper.getValid
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:22

schema

schema(): string
Returns string
Inherited from PayloadWrapper.schema
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:23

validate

validate(): Promise<Error[]>
Returns Promise<Error[]>
Inherited from PayloadWrapper.validate
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:39

`Static`as

as<
    T extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
>(
    value: unknown,
): null | PayloadDataWrapper<T>
Type Parameters
- T extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
Parameters
- value: unknown
Returns null | PayloadDataWrapper<T>
Inherited from PayloadWrapper.as
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:30

`Static`discover

discover(
    reverseDomainName: string,
    proxy?: string,
): Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
Parameters
- reverseDomainName: string
- Optionalproxy: string
Returns Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
- Defined in packages/core-payload-plugins/packages/domain/dist/neutral/index.d.ts:56

`Static`discoverDNSEntry

discoverDNSEntry(
    domain: string,
): Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
Parameters
- domain: string
Returns Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
- Defined in packages/core-payload-plugins/packages/domain/dist/neutral/index.d.ts:80

`Static`discoverRootFile

discoverRootFile(
    domain: string,
    proxy?: string,
): Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
Parameters
- domain: string
- Optionalproxy: string
Returns Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
- Defined in packages/core-payload-plugins/packages/domain/dist/neutral/index.d.ts:104

`Static`discoverRootFileDirect

discoverRootFileDirect(
    domain: string,
): Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
Parameters
- domain: string
Returns Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
- Defined in packages/core-payload-plugins/packages/domain/dist/neutral/index.d.ts:128

`Static`discoverRootFileWithProxy

discoverRootFileWithProxy(
    domain: string,
    proxy?: string,
): Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
Parameters
- domain: string
- Optionalproxy: string
Returns Promise<
    | undefined
    | DomainPayloadWrapper<
        DeepRestrictToStringKeys<
            {
                additional?: string[];
                aliases?: { [x: string]: { huri: string; name?: string } };
                networks?: {
                    name?: string;
                    nodes?: {
                        docs?: ...;
                        name?: ...;
                        schema: ...;
                        slug: ...;
                        type: ...;
                        uri: ...;
                        web?: ...;
                    }[];
                    schema: "network.xyo.network";
                    slug: string;
                }[];
                schema: "network.xyo.domain";
            },
        >,
    >,
>
- Defined in packages/core-payload-plugins/packages/domain/dist/neutral/index.d.ts:152

`Static`load

load(
    address: Lowercase<string>,
): Promise<
    null
    | PayloadDataWrapper<DeepRestrictToStringKeys<{ schema: string }>>,
>
Parameters
- address: Lowercase<string>
Returns Promise<null | PayloadDataWrapper<DeepRestrictToStringKeys<{ schema: string }>>>
Inherited from PayloadWrapper.load
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:31

`Static`parse

parse<T extends DeepRestrictToStringKeys<{ schema: string }>>(
payload?: unknown,
): undefined | PayloadDataWrapper<T>
Type Parameters
- T extends DeepRestrictToStringKeys<{ schema: string }>
Parameters
- Optionalpayload: unknown
Returns undefined | PayloadDataWrapper<T>
Inherited from PayloadWrapper.parse
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:34

`Static`setLoaderFactory

setLoaderFactory(factory: null | PayloadLoaderFactory): void
Parameters
- factory: null | PayloadLoaderFactory
Returns void
Inherited from PayloadWrapper.setLoaderFactory
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:35

`Static`tryParse

tryParse<T extends DeepRestrictToStringKeys<{ schema: string }>>(
obj: unknown,
): undefined | PayloadDataWrapper<T>
Type Parameters
- T extends DeepRestrictToStringKeys<{ schema: string }>
Parameters
- obj: unknown
Returns undefined | PayloadDataWrapper<T>
Inherited from PayloadWrapper.tryParse
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:36

`Static`unwrap

unwrap<
    TPayload extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
>(
    payload?: TPayload,
): undefined | TPayload
Type Parameters
- TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
Parameters
- Optionalpayload: TPayload
Returns undefined | TPayload
Inherited from PayloadWrapper.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:15
unwrap<
    TPayload extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: TPayload | TWrapper,
): TPayload
Type Parameters
- TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: TPayload | TWrapper
Returns TPayload
Inherited from PayloadWrapper.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:16
unwrap<
    TPayload extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: (TPayload | TWrapper)[],
): TPayload[]
Type Parameters
- TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: (TPayload | TWrapper)[]
Returns TPayload[]
Inherited from PayloadWrapper.unwrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:17

`Static`unwrapSinglePayload

unwrapSinglePayload<
    TPayload extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
>(
    payload?: TPayload,
): undefined | TPayload
Type Parameters
- TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
Parameters
- Optionalpayload: TPayload
Returns undefined | TPayload
Inherited from PayloadWrapper.unwrapSinglePayload
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:18
unwrapSinglePayload<
    TPayload extends
        DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<
        { schema: string },
    >,
    TWrapper extends
        PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>,
>(
    payload: TPayload | TWrapper,
): TPayload
Type Parameters
- TPayload extends DeepRestrictToStringKeys<{ schema: string }> = DeepRestrictToStringKeys<{ schema: string }>
- TWrapper extends PayloadWrapperBase<TPayload> = PayloadWrapperBase<TPayload>
Parameters
- payload: TPayload | TWrapper
Returns TPayload
Inherited from PayloadWrapper.unwrapSinglePayload
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:19

`Static`wrap

wrap<T extends DeepRestrictToStringKeys<{ schema: string }>>(
payload?: T | PayloadDataWrapper<T>,
): PayloadDataWrapper<T>
Type Parameters
- T extends DeepRestrictToStringKeys<{ schema: string }>
Parameters
- Optionalpayload: T | PayloadDataWrapper<T>
Returns PayloadDataWrapper<T>
Inherited from PayloadWrapper.wrap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:37

`Static`wrappedMap

wrappedMap<T extends DeepRestrictToStringKeys<{ schema: string }>>(
payloads: (T | PayloadDataWrapper<T>)[],
): Promise<Record<string, PayloadDataWrapper<T>>>
Type Parameters
- T extends DeepRestrictToStringKeys<{ schema: string }>
Parameters
- payloads: (T | PayloadDataWrapper<T>)[]
Returns Promise<Record<string, PayloadDataWrapper<T>>>
Inherited from PayloadWrapper.wrappedMap
- Defined in packages/protocol/packages/payload/packages/wrapper/dist/neutral/index.d.ts:38

Class DomainPayloadWrapper<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Type Parameters

Parameters

Returns DomainPayloadWrapper<T>

Properties

Optionalaliases

payload

Protected StaticloaderFactory

Methods

dataHash

Returns Promise<Lowercase<string>>

fetch

Parameters

Returns Promise<void>

fetchAliases

Parameters

Returns Promise<void>

getErrors

Returns Promise<Error[]>

getValid

Returns Promise<boolean>

schema

Returns string

validate

Returns Promise<Error[]>

Staticas

Type Parameters

Parameters

Returns null | PayloadDataWrapper<T>

Staticdiscover

Parameters

StaticdiscoverDNSEntry

Parameters

StaticdiscoverRootFile

Parameters

StaticdiscoverRootFileDirect

Parameters

StaticdiscoverRootFileWithProxy

Parameters

Staticload

Parameters

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

Staticparse

Type Parameters

Parameters

Returns undefined | PayloadDataWrapper<T>

StaticsetLoaderFactory

Parameters

Returns void

StatictryParse

Type Parameters

Parameters

Returns undefined | PayloadDataWrapper<T>

Staticunwrap

Type Parameters

Parameters

Returns undefined | TPayload

Type Parameters

Parameters

Returns TPayload

Type Parameters

Parameters

Returns TPayload[]

StaticunwrapSinglePayload

Type Parameters

Parameters

Returns undefined | TPayload

Type Parameters

Parameters

Returns TPayload

Staticwrap

Type Parameters

`Protected`constructor

`Optional`aliases

`Protected` `Static`loaderFactory

`Static`as

`Static`discover

`Static`discoverDNSEntry

`Static`discoverRootFile

`Static`discoverRootFileDirect

`Static`discoverRootFileWithProxy

`Static`load

`Static`parse

`Static`setLoaderFactory

`Static`tryParse

`Static`unwrap

`Static`unwrapSinglePayload

`Static`wrap

`Static`wrappedMap