Jexia Javascript SDK
  1. Classes
  2. DataOperationsModule

File

src/api/dataops/dataOperationsModule.ts

Description

Data Operation Module used to retrieve the dataset objects. This object must be build from the helper functions, never to be instantiated directly.

Example

```typescript

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

Implements

IModule

Index

Methods

Methods

Public dataset
dataset(dataset: string, auth?: string)
Type parameters :
  • T

Generates a dataset object of given name. For TypeScript users it implements a generic type T that represents your dataset (defaults to any).

Parameters :
Name Type Optional Description
dataset string No

name of the dataset
auth string Yes

use specific authorization
Returns : Dataset<T>

Dataset object used to fetch and modify data at your datasets.
Public datasets
datasets(datasets: [string, string], auth?: string)
Type parameters :
  • A
  • B
Parameters :
Name Type Optional
datasets [string, string] No
auth string Yes
Public datasets
datasets(datasets: [string, string, string], auth?: string)
Type parameters :
  • A
  • B
  • C
Parameters :
Name Type Optional
datasets [string, string, string] No
auth string Yes
Public datasets
datasets(datasets: [string, string, string, string], auth?: string)
Type parameters :
  • A
  • B
  • C
  • D
Parameters :
Name Type Optional
datasets [string, string, string, string] No
auth string Yes
Public datasets
datasets(datasets: [string, string, string, string, string], auth?: string)
Type parameters :
  • A
  • B
  • C
  • D
  • E
Parameters :
Name Type Optional
datasets [string, string, string, string, string] No
auth string Yes
Public datasets
datasets(datasets: [string, string, string, string, string, string], auth?: string)
Type parameters :
  • A
  • B
  • C
  • D
  • E
  • F
Parameters :
Name Type Optional
datasets [string, string, string, string, string, string] No
auth string Yes
Public datasets
datasets(datasets: string[], auth?: string)
Parameters :
Name Type Optional
datasets string[] No
auth string Yes
Returns : Dataset[]
Public datasets
datasets(datasets: string[], auth?: string)

Generates a list of datasets by given array of dataset names

Parameters :
Name Type Optional Description
datasets string[] No

array of dataset names
auth string Yes

optional user authorization alias
Returns : any
Public getConfig
getConfig()

Return configuration

Returns : literal type

result-matching ""

    No results matching ""