Jexia Javascript SDK
  1. Classes
  2. Client

File

src/api/core/client.ts

Description

Jexia main client fo the JavaScript SDK, used to initialize the necessary modules with your project information. This object must be build from the helper functions, never to be instantiated directly.

Example

```typescript

  • import { jexiaClient } from "jexia-sdk-js/node";
  • jexiaClient().init(credentials, arrayOfJexiaModules);
  • ```

Index

Methods

Methods

Static collectConfiguration
collectConfiguration(modules: IModule[])

Collect all module configurations into one configuration object

Parameters :
Name Type Optional
modules IModule[] No
Returns : literal type
Public init
init(opts: IAuthOptions, ...modules: IModule[])

Initialized the Jexia client with all the used modules

Parameters :
Name Type Optional Description
opts IAuthOptions No

Your project data
modules IModule[] No

Jexia modules that will be used
Returns : Promise<Client>

A promise that just finishes when all the given modules finished their initialization
Public terminate
terminate()

Terminate the Jexia client with all the used modules

Returns : Promise<Client>

A promise that just finishes when all the given modules finished their termination

result-matching ""

    No results matching ""