Class FunctionService<FunctionType>

An implementation of the FIN Function service.

Type Parameters

FunctionType extends FinFunction = FinFunction

Index

Constructors

Methods

create deleteById readAll readById update

Constructors

constructor

new FunctionService<FunctionType extends FinFunction = FinFunction>(
serviceConfig: ClientServiceConfig,
): FunctionService<FunctionType>
Constructs a new function service object.
Type Parameters
- FunctionType extends FinFunction = FinFunction
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
Returns FunctionService<FunctionType>
- Defined in src/client/functions/FunctionService.ts:69

Methods

create

create(
functions: HaysonDict[] | FunctionType[] | HGrid<FunctionType>,
): Promise<HGrid<FunctionType>>
Create function record(s).
Parameters
- functions: HaysonDict[] | FunctionType[] | HGrid<FunctionType>
  HGrid The functions to create.
Returns Promise<HGrid<FunctionType>>
A grid of functions.
- Defined in src/client/functions/FunctionService.ts:117

deleteById

deleteById(id: string | HRef): Promise<void>
Delete a function record via its id.
Parameters
- id: string | HRef
  The id of the record to delete.
Returns Promise<void>
- Defined in src/client/functions/FunctionService.ts:158

readAll

readAll(options?: ReadOptions): Promise<FunctionType[]>
Query all functions.
Parameters
- Optionaloptions: ReadOptions
  Optional options for read operation.
Returns Promise<FunctionType[]>
The result of the read operation.
- Defined in src/client/functions/FunctionService.ts:80

readById

readById(id: string | HRef): Promise<FunctionType>
Read a function record via its id.
Parameters
- id: string | HRef
  The id of the function to read.
Returns Promise<FunctionType>
The function record.

Throws
An error if the function can't be found.
- Defined in src/client/functions/FunctionService.ts:101

update

update(finFunction: HaysonDict | FunctionType): Promise<FunctionType>
Update a function record.
Parameters
- finFunction: HaysonDict | FunctionType
Returns Promise<FunctionType>
The updated record.
- Defined in src/client/functions/FunctionService.ts:137