Class Repository<ID>

Type parameters

ID: StreamID

Hierarchy

Repository

Index

Constructors

constructor

Properties

stream

Accessors

http

Methods

Constructors

constructor

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

- Defined in packages/@laravel-streams/api-client/src/Repository.ts:15
Create a new repository instance.

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

Properties

Protected stream

stream: Stream<ID>

Accessors

http

get http(): Http

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

Methods

all

all(): Promise<EntryCollection<ID>>

- Defined in packages/@laravel-streams/api-client/src/Repository.ts:26
Return all items.

Returns Promise<EntryCollection<ID>>
EntryCollection

create

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

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

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

delete

delete(entry: any): Promise<boolean>

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

Parameters
- entry: any
Returns Promise<boolean>

find

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

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

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

findAll

findAll(ids: (string | number)[]): Promise<EntryCollection<ID>>

- Defined in packages/@laravel-streams/api-client/src/Repository.ts:52
Find all records by IDs.

Parameters
- ids: (string | number)[]
Returns Promise<EntryCollection<ID>>
EntryCollection

findAllWhere

findAllWhere(field: string, value: any): Promise<EntryCollection<string | number>>

- Defined in packages/@laravel-streams/api-client/src/Repository.ts:73
Parameters
- field: string
- value: any
Returns Promise<EntryCollection<string | number>>

findBy

findBy(field: string, value: any): Promise<IEntry<ID>>

- Defined in packages/@laravel-streams/api-client/src/Repository.ts:66
Find an entry by a field value.

Parameters
- field: string
- value: any
Returns Promise<IEntry<ID>>
Entry

newCriteria

newCriteria(): Criteria<ID>

- Defined in packages/@laravel-streams/api-client/src/Repository.ts:136
Return a new entry criteria.

Returns Criteria<ID>
Criteria

newInstance

newInstance(attributes: any): IEntry<ID>

- Defined in packages/@laravel-streams/api-client/src/Repository.ts:127
Return a new instance.

Parameters
- attributes: any
Returns IEntry<ID>

save

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

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

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

truncate

truncate(): Repository<ID>

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