Interface ConfigLoadOptions

interface ConfigLoadOptions {
    dnsServers?: string[];
    fetchCidContent?: (cid: string, path?: string) => Promise<null | Blob>;
    fromCid?: string;
    fromDns?: string | boolean;
    fromLocalStorage?: boolean;
    fromUrlParam?: string | boolean;
    fromUrls?: boolean;
    ipfsGatewayServers?: (cid: string) => string[];
    order?: ConfigLoadMethod[];
    schema?: AnySchema;
    static?: Record<string, any>;
    strategy?: ConfigLoadingStrategy;
    url?: string | string[] | (environment: Environment) => string | string[];
}

Properties

dnsServers? fetchCidContent? fromCid? fromDns? fromLocalStorage? fromUrlParam? fromUrls? ipfsGatewayServers? order? schema? static? strategy? url?

Properties

OptionaldnsServers

dnsServers?: string[]

OptionalfetchCidContent

fetchCidContent?: (cid: string, path?: string) => Promise<null | Blob>

OptionalfromCid

fromCid?: string

Load additional configuration directly from the given Content Identifier (CID). This takes precedence over fromDns if both are provided.

OptionalfromDns

fromDns?: string | boolean

Load additional configuration based on a CID found in a DNS TXT record. If true, uses location.hostname. If a string, uses that domain.

OptionalfromLocalStorage

fromLocalStorage?: boolean

OptionalfromUrlParam

fromUrlParam?: string | boolean

OptionalfromUrls

fromUrls?: boolean

OptionalipfsGatewayServers

ipfsGatewayServers?: (cid: string) => string[]

Optionalorder

order?: ConfigLoadMethod[]

Defines the order and subset of config sources to load. If not specified, defaults to: [FROM_URLS, FROM_LOCAL_STORAGE, FROM_URL_PARAM, FROM_CID]

Note: static config is always merged first, and Overwrites are always merged last. Note: fromDns is not a source itself - it resolves the CID for FROM_CID.

Optionalschema

schema?: AnySchema

Optionalstatic

static?: Record<string, any>

static config values

Optionalstrategy

strategy?: ConfigLoadingStrategy

Optionalurl

url?: string | string[] | (environment: Environment) => string | string[]

Settings

Member Visibility

On This Page

Properties