SudoSOS Back-end API / write-offs / WriteOffService
Class: WriteOffService ​
Extends ​
Constructors ​
Constructor ​
ts
new WriteOffService(manager?): WriteOffService;Parameters ​
| Parameter | Type |
|---|---|
manager? | EntityManager |
Returns ​
WriteOffService
Inherited from ​
Properties ​
| Property | Modifier | Type | Inherited from |
|---|---|---|---|
manager | protected | EntityManager | WithManager.manager |
Methods ​
createWriteOff() ​
ts
createWriteOff(user): Promise<WriteOff>;Creates a write-off for the given user
Parameters ​
| Parameter | Type | Description |
|---|---|---|
user | User | The user to create the write-off for |
Returns ​
Promise<WriteOff>
createWriteOffAndCloseUser() ​
ts
createWriteOffAndCloseUser(user): Promise<WriteOff>;Parameters ​
| Parameter | Type |
|---|---|
user | User |
Returns ​
Promise<WriteOff>
asBaseWriteOffResponse() ​
ts
static asBaseWriteOffResponse(writeOff): BaseWriteOffResponse;Parses a write-off object to a BaseWriteOffResponse
Parameters ​
| Parameter | Type | Description |
|---|---|---|
writeOff | WriteOff | - |
Returns ​
asWriteOffResponse() ​
ts
static asWriteOffResponse(writeOff): WriteOffResponse;Parses a write-off object to a WriteOffResponse
Parameters ​
| Parameter | Type | Description |
|---|---|---|
writeOff | WriteOff | - |
Returns ​
getOptions() ​
ts
static getOptions(params): FindManyOptions<WriteOff>;Function that returns FindManyOptions based on the given parameters
Parameters ​
| Parameter | Type | Description |
|---|---|---|
params | WriteOffFilterParameters | - |
Returns ​
FindManyOptions<WriteOff>
getWriteOffs() ​
ts
static getWriteOffs(filters?, pagination?): Promise<[WriteOff[], number]>;Returns all write-offs with options.
Parameters ​
| Parameter | Type | Description |
|---|---|---|
filters | WriteOffFilterParameters | The filtering parameters. |
pagination | PaginationParameters | The pagination options. |
Returns ​
Promise<[WriteOff[], number]>
- all write-offs and total count