Interface ClientConfigBuilder

config

add

• add(config): ClientConfigBuilder

• Add a partial BuilderConfig This is equivalent to calling each of the plural add functions: addEnvs, setWrappers, etc.

  Parameters

  • config: Partial<BuilderConfig>

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

addBundle

• addBundle(bundle): ClientConfigBuilder

• Add a default configuration bundle

  Parameters

  • bundle: BundleName

  Returns ClientConfigBuilder

  Promise (mutated self)

addDefaults

• addDefaults(): ClientConfigBuilder

• Add the default configuration bundle

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

addEnv

• addEnv(uri, env): ClientConfigBuilder

• Add an Env. If an Env is already associated with the uri, it is modified.

  Parameters

  • uri: string

  • env: Record<string, unknown>

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

addEnvs

• addEnvs(uriEnvs): ClientConfigBuilder

• Add one or more Envs This is equivalent to calling addEnv for each Env

  Parameters

  • uriEnvs: Record<string, Record<string, unknown>>

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

addInterfaceImplementation

• addInterfaceImplementation(interfaceUri, implementationUri): ClientConfigBuilder

• Register an implementation of a single interface

  Parameters

  • interfaceUri: string

  • implementationUri: string

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

addInterfaceImplementations

• addInterfaceImplementations(interfaceUri, implementationUris): ClientConfigBuilder

• Register one or more implementation of a single interface

  Parameters

  • interfaceUri: string

  • implementationUris: string[]

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

addResolver

• addResolver(resolver): ClientConfigBuilder

• Add a URI Resolver, capable of resolving a URI to a wrapper

  Parameters

  • resolver: UriResolverLike

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

  Remarks

  A UriResolverLike can be any one of: IUriResolver | IUriRedirect | IUriPackage | IUriWrapper | UriResolverLike[];

addResolvers

• addResolvers(resolvers): ClientConfigBuilder

• Add one or more URI Resolvers, capable of resolving URIs to wrappers

  Parameters

  • resolvers: UriResolverLike[]

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

  Remarks

  A UriResolverLike can be any one of: IUriResolver | IUriRedirect | IUriPackage | IUriWrapper | UriResolverLike[];

build

• build(options?): CoreClientConfig

• Build a sanitized core client configuration that can be passed to the PolywrapClient or PolywrapCoreClient constructors

  Parameters

  • Optional options: BuildOptions

    Use a custom wrapper cache or resolver

  Returns CoreClientConfig

  CoreClientConfig that results from applying all the steps in the builder pipeline

removeEnv

• removeEnv(uri): ClientConfigBuilder

• Remove an Env

  Parameters

  • uri: string

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

removeInterfaceImplementation

• removeInterfaceImplementation(interfaceUri, implementationUri): ClientConfigBuilder

• Remove an implementation of a single interface

  Parameters

  • interfaceUri: string

  • implementationUri: string

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

removePackage

• removePackage(uri): ClientConfigBuilder

• Remove an embedded wrap package

  Parameters

  • uri: string

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

removeRedirect

• removeRedirect(from): ClientConfigBuilder

• Remove a URI redirect

  Parameters

  • from: string

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

removeWrapper

• removeWrapper(uri): ClientConfigBuilder

• Remove an embedded wrapper

  Parameters

  • uri: string

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

setEnv

• setEnv(uri, env): ClientConfigBuilder

• Add an Env. If an Env is already associated with the uri, it is replaced.

  Parameters

  • uri: string

  • env: Record<string, unknown>

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

setPackage

• setPackage(uri, wrapPackage): ClientConfigBuilder

• Add an embedded wrap package

  Parameters

  • uri: string

  • wrapPackage: IWrapPackage

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

setPackages

• setPackages(uriPackages): ClientConfigBuilder

• Add one or more embedded wrap packages This is equivalent to calling setPackage for each package

  Parameters

  • uriPackages: Record<string, IWrapPackage>

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

setRedirect

• setRedirect(from, to): ClientConfigBuilder

• Add a redirect from one URI to another

  Parameters

  • from: string

  • to: string

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

setRedirects

• setRedirects(redirects): ClientConfigBuilder

• Add an array of URI redirects

  Parameters

  • redirects: Record<string, string>

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

setWrapper

• setWrapper(uri, wrapper): ClientConfigBuilder

• Add an embedded wrapper

  Parameters

  • uri: string

  • wrapper: Wrapper

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)

setWrappers

• setWrappers(uriWrappers): ClientConfigBuilder

• Add one or more embedded wrappers. This is equivalent to calling setWrapper for each wrapper.

  Parameters

  • uriWrappers: Record<string, Wrapper>

  Returns ClientConfigBuilder

  ClientConfigBuilder (mutated self)