Class Criteria<ID>

Type parameters

ID: StreamID = StreamID

Hierarchy

Criteria

Index

Constructors

constructor

Properties

Accessors

http

Methods

Constructors

constructor

new Criteria<ID>(stream: Stream<ID>): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:64
Create a new instance.

Type parameters
- ID: string | number = string | number
Parameters
- stream: Stream<ID>
Returns Criteria<ID>

Properties

parameters

parameters: CriteriaParameter[] = []

Protected stream

stream: Stream<ID>

Accessors

http

get http(): Http

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:66
Returns Http

Methods

Protected addParameter

addParameter(name: string, value: any): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:284
Add a statement.

Parameters
- name: string
- value: any
Returns Criteria<ID>

cache

cache(): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:90
Returns Criteria<ID>

compileParameters

compileParameters(): string

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:300
Returns string

create

create(attributes: any): Promise<IEntry<ID>>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:222
Create a new entry.

Parameters
- attributes: any
Returns Promise<IEntry<ID>>

delete

delete(): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:241
Returns Criteria<ID>

find

find(id: string | number): Promise<IEntry<ID>>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:74
Find an entry by ID.

Parameters
- id: string | number
Returns Promise<IEntry<ID>>

first

first(): Promise<IEntry<ID>>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:83
Return the first result.

Returns Promise<IEntry<ID>>

get

get(): Promise<EntryCollection<ID>>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:192
Get the criteria results.

Returns Promise<EntryCollection<ID>>

getParameters

getParameters(): any

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:260
Get the parameters.

Returns any

limit

limit(value: number): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:112
Limit the entries returned.

Parameters
- value: number
Returns Criteria<ID>

newInstance

newInstance(attributes: any): IEntry<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:251
Return an entry instance.

Parameters
- attributes: any
Returns IEntry<ID>
Entry

orWhere

orWhere<K>(key: K, operator: Operator, value: IEntries[ID][K]): Criteria<ID>
orWhere<K>(key: K, value: IEntries[ID][K]): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:160
Type parameters
- K: string | number | symbol
Parameters
- key: K
- operator: Operator
- value: IEntries[ID][K]
Returns Criteria<ID>
- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:161
Type parameters
- K: string | number | symbol
Parameters
- key: K
- value: IEntries[ID][K]
Returns Criteria<ID>

orderBy

orderBy<K>(key: string, direction?: OrderByDirection): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:99
Order the query by field/direction.

Type parameters
- K: string | number | symbol
Parameters
- key: string
- direction: OrderByDirection = 'desc'
Returns Criteria<ID>

paginate

paginate(per_page?: number, page?: number): Promise<PaginatedEntryCollection<ID>>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:206
Get paginated criteria results.

Parameters
- per_page: number = 100
- page: number = 1
Returns Promise<PaginatedEntryCollection<ID>>

save

save(entry: Entry<string | number>): Promise<boolean>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:237
Save an entry.

Parameters
- entry: Entry<string | number>
Returns Promise<boolean>

setParameters

setParameters(parameters: any): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:270
Set the parameters.

Parameters
- parameters: any
Returns Criteria<ID>

standardizeParameters

standardizeParameters(): {}[]

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:296
Return standardized parameters.

Returns {}[]

where

where<K>(key: K, operator: Operator, value: IEntries[ID][K], nested: any): Criteria<ID>
where<K>(key: K, operator: Operator, value: IEntries[ID][K]): Criteria<ID>
where<K>(key: K, value: IEntries[ID][K]): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:126
Constrain the query by a typical field, operator, value argument.

Type parameters
- K: string | number | symbol
Parameters
- key: K
- operator: Operator
- value: IEntries[ID][K]
- nested: any
Returns Criteria<ID>
- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:127
Type parameters
- K: string | number | symbol
Parameters
- key: K
- operator: Operator
- value: IEntries[ID][K]
Returns Criteria<ID>
- Defined in packages/@laravel-streams/api-client/src/Criteria.ts:128
Type parameters
- K: string | number | symbol
Parameters
- key: K
- value: IEntries[ID][K]
Returns Criteria<ID>