Class ArnHttpClientFactory

Creates a client that will connect to an ARN Server.

Hierarchy

ArnHttpClientFactory

Implements

ArnClientFactory<ArnHttpClientConfig>

Index

Constructors

constructor

new ArnHttpClientFactory(serviceFactories?: Partial<ArnServiceFactories>): ArnHttpClientFactory
Creates an ARN Client factory.
Parameters
- serviceFactories: Partial<ArnServiceFactories> = {}
  
  The custom service factories, if any.
Returns ArnHttpClientFactory
- Defined in packages/arn-client/src/ArnHttpClientFactory.ts:69

Properties

`Readonly` configByUrl

configByUrl: Map<string, ArnValidClientConfig> = ...

Configuration cache, by API key.

`Protected` serviceFactories

serviceFactories: ArnServiceFactories

Factories to instantiate services and their configurations.

`Static` `Readonly` defaultServiceFactories

defaultServiceFactories: ArnClientServiceIndexed<(() => any)> = ...

Default implementations of service factories.

They are construction methods instead of instances to avoid instantiating them if they are to be replaced.

Methods

create

create(spec: ArnHttpClientConfig): ArnClient
Create an ARN Client, with some configuration spec.
Parameters
- spec: ArnHttpClientConfig
  
  A partial configuration that will be completed by defaults.
Returns ArnClient
Implementation of ArnClientFactory.create
- Defined in packages/arn-client/src/ArnHttpClientFactory.ts:85

createConfig

createConfig(spec: ArnClientConfig, serverUrl: string): ArnValidHttpClientConfig
Utility method to converts a configuration with optionals to a valid configuration with possible defaults applied.
Parameters
- spec: ArnClientConfig
  
  The config values to override defaults.
- serverUrl: string
  
  The server to connect to, if config does not use absolute urls.
Returns ArnValidHttpClientConfig
- Defined in packages/arn-client/src/ArnHttpClientFactory.ts:147

createConfigFromUrl

createConfigFromUrl(projectUrl: string): Promise<ArnValidClientConfig>
Fetch a remote ARN project configuration.
Parameters
- projectUrl: string
  
  The URL of the project.
Returns Promise<ArnValidClientConfig>
- Defined in packages/arn-client/src/ArnHttpClientFactory.ts:195

createFromUrl

createFromUrl(projectUrl: string): Promise<ArnClient>
Create an ARN Client associated with a given remote project.
Parameters
- projectUrl: string
  
  The URL of the project.
Returns Promise<ArnClient>
- Defined in packages/arn-client/src/ArnHttpClientFactory.ts:185

Class ArnHttpClientFactory

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

serviceFactories: Partial<ArnServiceFactories> = {}

Returns ArnHttpClientFactory

Properties

`Readonly` configByUrl

`Protected` serviceFactories

`Static` `Readonly` defaultServiceFactories

Methods

create

Parameters

spec: ArnHttpClientConfig

Returns ArnClient

createConfig

Parameters

spec: ArnClientConfig

serverUrl: string

Returns ArnValidHttpClientConfig

createConfigFromUrl

Parameters

projectUrl: string

Returns Promise<ArnValidClientConfig>

createFromUrl

Parameters

projectUrl: string

Returns Promise<ArnClient>

Settings

Member Visibility

Theme

Class ArnHttpClientFactory

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

serviceFactories: Partial<ArnServiceFactories> = {}

Returns ArnHttpClientFactory

Properties

Readonly configByUrl

Protected serviceFactories

Static Readonly defaultServiceFactories

Methods

create

Parameters

spec: ArnHttpClientConfig

Returns ArnClient

createConfig

Parameters

spec: ArnClientConfig

serverUrl: string

Returns ArnValidHttpClientConfig

createConfigFromUrl

Parameters

projectUrl: string

Returns Promise<ArnValidClientConfig>

createFromUrl

Parameters

projectUrl: string

Returns Promise<ArnClient>

Settings

Member Visibility

Theme

`Readonly` configByUrl

`Protected` serviceFactories

`Static` `Readonly` defaultServiceFactories