UNPKG

@rxap/config

Version:

Provides a configuration service for Angular applications, allowing you to load and manage application settings from various sources such as static files, URLs, local storage, and URL parameters. It supports schema validation and provides utilities for ac

152 lines (78 loc) 4.41 kB
[**@rxap/config v19.3.0-dev.2**](../README.md) *** [@rxap/config](../globals.md) / ConfigLoadOptions # Interface: ConfigLoadOptions Defined in: [config.service.ts:36](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L36) ## Properties ### dnsServers? > `optional` **dnsServers**: `string`[] Defined in: [config.service.ts:58](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L58) *** ### fetchCidContent()? > `optional` **fetchCidContent**: (`cid`, `path`?) => `Promise`\<`null` \| `Blob`\> Defined in: [config.service.ts:56](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L56) #### Parameters ##### cid `string` ##### path? `string` #### Returns `Promise`\<`null` \| `Blob`\> *** ### fromCid? > `optional` **fromCid**: `string` Defined in: [config.service.ts:55](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L55) Load additional configuration directly from the given Content Identifier (CID). This takes precedence over `fromDns` if both are provided. *** ### fromDns? > `optional` **fromDns**: `string` \| `boolean` Defined in: [config.service.ts:50](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L50) Load additional configuration based on a CID found in a DNS TXT record. If true, uses `location.hostname`. If a string, uses that domain. *** ### fromLocalStorage? > `optional` **fromLocalStorage**: `boolean` Defined in: [config.service.ts:39](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L39) *** ### fromUrlParam? > `optional` **fromUrlParam**: `string` \| `boolean` Defined in: [config.service.ts:37](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L37) *** ### fromUrls? > `optional` **fromUrls**: `boolean` Defined in: [config.service.ts:38](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L38) *** ### ipfsGatewayServers? > `optional` **ipfsGatewayServers**: (`cid`) => `string`[] Defined in: [config.service.ts:57](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L57) #### Parameters ##### cid `string` #### Returns `string` *** ### order? > `optional` **order**: [`ConfigLoadMethod`](../enumerations/ConfigLoadMethod.md)[] Defined in: [config.service.ts:67](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L67) 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. *** ### schema? > `optional` **schema**: [`AnySchema`](../type-aliases/AnySchema.md) Defined in: [config.service.ts:40](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L40) *** ### static? > `optional` **static**: `Record`\<`string`, `any`\> Defined in: [config.service.ts:45](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L45) static config values *** ### strategy? > `optional` **strategy**: [`ConfigLoadingStrategy`](../enumerations/ConfigLoadingStrategy.md) Defined in: [config.service.ts:59](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L59) *** ### url? > `optional` **url**: `string` \| `string`[] \| (`environment`) => `string` \| `string`[] Defined in: [config.service.ts:41](https://gitlab.com/rxap/packages/-/blob/ad2fedf899842d718c345d791ac885f1247525a3/packages/angular/config/src/lib/config.service.ts#L41)