Class DataSourceCustomizer<S>

Allow to create a new Forest Admin agent from scratch. Builds the application by composing and configuring all the collection decorators.

Minimal code to add a datasource

Example

new AgentBuilder(options)
 .addDataSource(new SomeDataSource())
 .start();

Type Parameters

S extends TSchema = TSchema

Index

Constructors

constructor

new DataSourceCustomizer<S extends TSchema = TSchema>(
options?: Options,
): DataSourceCustomizer<S>
Type Parameters
- S extends TSchema = TSchema
Parameters
- Optionaloptions: Options
Returns DataSourceCustomizer<S>
- Defined in datasource-customizer.ts:55

Properties

`Protected`compositeDataSource

compositeDataSource: CompositeDatasource<Collection>

`Protected` `Readonly`stack

stack: DecoratorsStack

Accessors

collections

get collections(): CollectionCustomizer<S, Extract<keyof S, string>>[]
Get list of customizable collections

Returns CollectionCustomizer<S, Extract<keyof S, string>>[]
- Defined in datasource-customizer.ts:49

schema

get schema(): DataSourceSchema
Retrieve schema of the agent

Returns DataSourceSchema
- Defined in datasource-customizer.ts:42

Methods

addChart

addChart(name: string, definition: DataSourceChartDefinition<S>): this
Create a new API chart
Parameters
- name: string
  name of the chart
- definition: DataSourceChartDefinition<S>
  definition of the chart
Returns this
Example
```
.addChart('numCustomers', {
  type: 'Value',
  render: (context, resultBuilder) => {
    return resultBuilder.value(123);
  }
})
```
- Defined in datasource-customizer.ts:105

addDataSource

addDataSource(
    factory: DataSourceFactory,
    options?: DataSourceOptions,
    restartAgentFunction?: () => Promise<void>,
): this
Add a datasource
Parameters
- factory: DataSourceFactory
  the datasource to add
- Optionaloptions: DataSourceOptions
  the options
- OptionalrestartAgentFunction: () => Promise<void>
Returns this
- Defined in datasource-customizer.ts:67

customizeCollection

customizeCollection<N extends string>(
name: N,
handle: (collection: CollectionCustomizer<S, N>) => unknown,
): this
Allow to interact with a decorated collection
Type Parameters
- N extends string
Parameters
- name: N
  the name of the collection to manipulate
- handle: (collection: CollectionCustomizer<S, N>) => unknown
  a function that provide a collection builder on the given collection name
Returns this
Example
```
.customizeCollection('books', books => books.renameField('xx', 'yy'))
```
- Defined in datasource-customizer.ts:121

findCollection

findCollection(name: string): CollectionCustomizer<S, Extract<keyof S, string>>
Find a collection by name. Returns undefined if the collection is missing
Parameters
- name: string
  name of the collection
Returns CollectionCustomizer<S, Extract<keyof S, string>>
- Defined in datasource-customizer.ts:142

getCollection

getCollection<N extends string>(name: N): CollectionCustomizer<S, N>
Get given collection by name
Type Parameters
- N extends string
Parameters
- name: N
  name of the collection
Returns CollectionCustomizer<S, N>
- Defined in datasource-customizer.ts:134

getDataSource

getDataSource(logger: Logger): Promise<DataSource<Collection>>
Parameters
- logger: Logger
Returns Promise<DataSource<Collection>>
- Defined in datasource-customizer.ts:182

getFactory

getFactory(): DataSourceFactory
Returns DataSourceFactory
- Defined in datasource-customizer.ts:189

removeCollection

removeCollection(...names: Extract<keyof S, string>[]): this
Remove collections from the exported schema (they will still be usable within the agent).
Parameters
- ...names: Extract<keyof S, string>[]
  the collections to remove
Returns this
Example
```
.removeCollection('aCollectionToRemove', 'anotherCollectionToRemove');
```
- Defined in datasource-customizer.ts:157

updateTypesOnFileSystem

updateTypesOnFileSystem(
    typingsPath: string,
    typingsMaxDepth: number,
    logger?: Logger,
): Promise<void>
Parameters
- typingsPath: string
- typingsMaxDepth: number
- Optionallogger: Logger
Returns Promise<void>
- Defined in datasource-customizer.ts:193

use

use<TOptions>(plugin: Plugin<TOptions>, options?: TOptions): this
Load a plugin across all collections
Type Parameters
- TOptions
Parameters
- plugin: Plugin<TOptions>
  instance of the plugin
- Optionaloptions: TOptions
  options which need to be passed to the plugin
Returns this
Example
```
import { advancedExport } from '@forestadmin/plugin-advanced-export';

dataSourceCustomizer.use(advancedExportPlugin, { format: 'xlsx' });
```
- Defined in datasource-customizer.ts:174

Class DataSourceCustomizer<S>

Example

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns DataSourceCustomizer<S>

Properties

ProtectedcompositeDataSource

Protected Readonlystack

Accessors

collections

Returns CollectionCustomizer<S, Extract<keyof S, string>>[]

schema

Returns DataSourceSchema

Methods

addChart

Parameters

Returns this

Example

addDataSource

Parameters

Returns this

customizeCollection

Type Parameters

Parameters

Returns this

Example

findCollection

Parameters

Returns CollectionCustomizer<S, Extract<keyof S, string>>

getCollection

Type Parameters

Parameters

Returns CollectionCustomizer<S, N>

getDataSource

Parameters

Returns Promise<DataSource<Collection>>

getFactory

Returns DataSourceFactory

removeCollection

Parameters

Returns this

Example

updateTypesOnFileSystem

Parameters

Returns Promise<void>

use

Type Parameters

Parameters

Returns this

Example

Settings

On This Page

`Protected`compositeDataSource

`Protected` `Readonly`stack