Skip to main content
Version: v10.0.0

CollectionHandle

A collection inside a db: queries start here, and writes go through it


Import
import { CollectionHandle } from "@hyper-fetch/db"

Parameters​

class CollectionHandle<Row, Input, KeyField, Loaders, Mutations> {
constructor(runtime: DbRuntime, name: string) {};
update: UpdateMethod<NonNullable<Row[KeyField]>, Mutations>;
insert: InsertMethod<Mutations>;
delete: DeleteMethod<NonNullable<Row[KeyField]>, Mutations>;
collectionName: string;
__types: { input: Input; key: KeyField; loaders: Loaders; mutations: Mutations; row: Row };
findOne(key: NonNullable<Row[KeyField]>) => Query<Row, Loaders, Row, never, never, never, one, false>;
join<Name, Target, Field, On, Type>(name: Name, collection: Target, by: JoinSpec<Row, Field, JoinedMatchOf<Target, On>, On, Type>) => Query<Row, Loaders, Joined<Row, Name, JoinedValue<JoinedRowOf<Target>, On, Type>>, never, never, never, list, false>;
limit(limit: number) => Query<Row, Loaders, Row, never, never, never, list, false>;
local() => Query<Row, Loaders, Row, never, never, never, list, true>;
orderBy<Name>(callback: (row: RowRefs<Row>) => FieldRef<Name, Row[Name]>, direction?: SortDirection) => Query<Row, Loaders, Row, never, never, Name, list, false>;
renderKey(key: NonNullable<Row[KeyField]>) => string;
select<Selection>(callback: (row: RowRefs<Row>) => Selection) => Query<Row, Loaders, Selected<Selection>, never, never, never, list, false>;
where<C>(callback: (row: RowRefs<Row>) => C) => Query<Row, Loaders, Row, ExtractConditionTokens<C>, ExtractConditionEq<C>, never, list, false>;
}
Parameters
NameTypeDescription
runtime
DbRuntime
name
string

Properties​

collectionName​

The collection's name in createDb

Type
string

delete​

Adds an optimistic delete and sends it

Type
DeleteMethod<NonNullable<Row[KeyField]>, Mutations>

insert​

Adds an optimistic insert and sends it. A row without a key gets a temporary one until the server assigns it.

Type
InsertMethod<Mutations>

update​

Adds an optimistic update and sends it

Type
UpdateMethod<NonNullable<Row[KeyField]>, Mutations>

__types​

Type-only carrier of the handle's generics, never set at runtime

Type
{ input: Input; key: KeyField; loaders: Loaders; mutations: Mutations; row: Row }

Methods​

findOne()​

Reads one row by key

Preview
findOne(key: NonNullable<Row[KeyField]>)
Parameters
Parameters
NameTypeDescription
key
NonNullable<Row[KeyField]>
Returns
Query<Row, Loaders, Row, never, never, never, one, false>

join()​

Adds the row of another collection whose key is the given field. See Query.join .

Preview
join<Name, Target, Field, On, Type>(name: Name, collection: Target, by: JoinSpec<Row, Field, JoinedMatchOf<Target, On>, On, Type>)
Parameters
Parameters
NameTypeDescription
name
Name
collection
Target
by
JoinSpec<Row, Field, JoinedMatchOf<Target, On>, On, Type>
Returns
Query<Row, Loaders, Joined<Row, Name, JoinedValue<JoinedRowOf<Target>, On, Type>>, never, never, never, list, false>

limit()​

Preview
limit(limit: number)
Parameters
Parameters
NameTypeDescription
limit
number
Returns
Query<Row, Loaders, Row, never, never, never, list, false>

local()​

Reads only the rows the db holds and never sends a request

Preview
local()
Returns
Query<Row, Loaders, Row, never, never, never, list, true>

orderBy()​

Preview
orderBy<Name>(callback: (row: RowRefs<Row>) => FieldRef<Name, Row[Name]>, direction: SortDirection)
Parameters
Parameters
NameTypeDescription
callback
(row: RowRefs<Row>) => FieldRef<Name, Row[Name]>
direction
SortDirection
Returns
Query<Row, Loaders, Row, never, never, Name, list, false>

renderKey()​

The key to render a row with. It stays the same when a temporary key is swapped for the server's.

Preview
renderKey(key: NonNullable<Row[KeyField]>)
Parameters
Parameters
NameTypeDescription
key
NonNullable<Row[KeyField]>
Returns
string

select()​

Preview
select<Selection>(callback: (row: RowRefs<Row>) => Selection)
Parameters
Parameters
NameTypeDescription
callback
(row: RowRefs<Row>) => Selection
Returns
Query<Row, Loaders, Selected<Selection>, never, never, never, list, false>

where()​

Preview
where<C>(callback: (row: RowRefs<Row>) => C)
Parameters
Parameters
NameTypeDescription
callback
(row: RowRefs<Row>) => C
Returns
Query<Row, Loaders, Row, ExtractConditionTokens<C>, ExtractConditionEq<C>, never, list, false>