Module functions/network

Index

Functions

Functions

createNetworkConfig

createNetworkConfig(config: { content: { search: { url: string; }; list: { url: string; }; feed: { url: string; }; link: { url: string; }; beacon: { url: string; }; }; domain: string; name: string; services: { api: { url: string; }; } }): DataResponse

Create and save a Network Configuration that can be used to update configurations.

Parameters
- config: { content: { search: { url: string; }; list: { url: string; }; feed: { url: string; }; link: { url: string; }; beacon: { url: string; }; }; domain: string; name: string; services: { api: { url: string; }; } }
  
  Network config object
  - content: { search: { url: string; }; list: { url: string; }; feed: { url: string; }; link: { url: string; }; beacon: { url: string; }; }
  - domain: string
  - name: string
  - services: { api: { url: string; }; }
Returns DataResponse
Success or Failure Message Response

getDefaultNetwork

getDefaultNetwork(): DataResponse

Get an array of the default domains for the network configuration.

Returns DataResponse
Success or Failure Message Response including an array of the default domains

getNetworkConfig

getNetworkConfig(domains?: string | boolean): Promise<DataResponse>

Get the network configunations for the specified networks. If domain is skipped or false, return current default configs. If domain is true, return all available configs.

Parameters
- domains: string | boolean = false
  
  colon separated list of network domains
Returns Promise<DataResponse>
Success or Failure Message Response including an array of the configs

removeNetworkConfig

removeNetworkConfig(domains: string): Promise<DataResponse>

Remove specified networks completely. If a specified network is a default, it will be removed from the list of defaults.

Parameters
- domains: string
  
  colon separated list of network domains
Returns Promise<DataResponse>
Success or Failure Message Response including an array of the files deleted

setDefaultNetwork

setDefaultNetwork(domains: string, overwrite?: boolean): DataResponse

Set the default network config(s). Unless indicated otherwise, specified domains will be added to current default list.

Parameters
- domains: string
  
  colon separated list of network domains
- overwrite: boolean = false
  
  should the list of domains completely overwrite current defaults
Returns DataResponse
Success or Failure Message Response including the current defaults