Class UserService<UserType>

An implementation of the FIN user service.

Type Parameters

UserType extends User = User

Index

Constructors

Methods

create createUser deleteById readAll readByFilter readById update

Constructors

constructor

new UserService<UserType extends User = User>(
serviceConfig: ClientServiceConfig,
): UserService<UserType>
Constructs a new user service object.
Type Parameters
- UserType extends User = User
Parameters
- serviceConfig: ClientServiceConfig
  Service configuration.
Returns UserService<UserType>
- Defined in src/client/UserService.ts:42

Methods

create

create(
users: HaysonDict[] | HGrid<UserType> | HList<UserType> | UserType[],
): Promise<HGrid<UserType>>
Create multiple user records.
Parameters
- users: HaysonDict[] | HGrid<UserType> | HList<UserType> | UserType[]
  The users to create.
Returns Promise<HGrid<UserType>>
A grid of users.
- Defined in src/client/UserService.ts:113

createUser

createUser(user: HaysonDict | UserType): Promise<UserType>
Create a single user record.
Parameters
- user: HaysonDict | UserType
  The user record to create.
Returns Promise<UserType>
The created user record.
- Defined in src/client/UserService.ts:133

deleteById

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

readAll

readAll(options?: UserReadOptions): Promise<HGrid<UserType>>
Query all users.
Parameters
- Optionaloptions: UserReadOptions
  Optional options for read operation.
Returns Promise<HGrid<UserType>>
The result of the read operation.
- Defined in src/client/UserService.ts:95

readByFilter

readByFilter(
filter: string,
options?: UserReadOptions,
): Promise<HGrid<UserType>>
Query some users via a haystack filter.
Parameters
- filter: string
  The haystack filter to query by.
- Optionaloptions: UserReadOptions
  Optional options for read operation.
Returns Promise<HGrid<UserType>>
The result of the read operation.
- Defined in src/client/UserService.ts:73

readById

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

Throws
An error if the user can't be found.
- Defined in src/client/UserService.ts:54

update

update(user: HaysonDict | UserType): Promise<UserType>
Update a user record.
Parameters
- user: HaysonDict | UserType
  The user record to update.
Returns Promise<UserType>
A updated record. Please note, this record doesn't have any user information just the id and mod.
- Defined in src/client/UserService.ts:152