ServiceHandle
Defined in: types.ts:331
Extends
Section titled “Extends”Service<T>
Type Parameters
Section titled “Type Parameters”T
Properties
Section titled “Properties”methods
Section titled “methods”
readonlymethods:string[]
Defined in: types.ts:336
publisher?
Section titled “publisher?”
readonlyoptionalpublisher?:ChannelPublisher<unknown>
Defined in: types.ts:338
schema?
Section titled “schema?”
readonlyoptionalschema?:unknown
Defined in: types.ts:335
Methods
Section titled “Methods”create()
Section titled “create()”create(
data,params?):Promise<T>
Defined in: types.ts:73
Parameters
Section titled “Parameters”D
params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”describe()
Section titled “describe()”describe():
ServiceDescriptor
Defined in: types.ts:334
Returns
Section titled “Returns”dispatch()
Section titled “dispatch()”dispatch(
method,data?,id?,params?):Promise<T|T[] |Paginated<T>>
Defined in: types.ts:333
Parameters
Section titled “Parameters”method
Section titled “method”string
Partial<T>
params?
Section titled “params?”Returns
Section titled “Returns”Promise<T | T[] | Paginated<T>>
find()
Section titled “find()”find(
params?):Promise<T[] |Paginated<T>>
Defined in: types.ts:71
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T[] | Paginated<T>>
Inherited from
Section titled “Inherited from”get(
id,params?):Promise<T>
Defined in: types.ts:72
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”hooks()
Section titled “hooks()”hooks(
config):this
Defined in: types.ts:332
Parameters
Section titled “Parameters”config
Section titled “config”HookConfig<T>
Returns
Section titled “Returns”this
patch()
Section titled “patch()”patch(
id,data,params?):Promise<T>
Defined in: types.ts:75
Parameters
Section titled “Parameters”D
params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”publish()
Section titled “publish()”publish(
publisher):this
Defined in: types.ts:337
Parameters
Section titled “Parameters”publisher
Section titled “publisher”Returns
Section titled “Returns”this
remove()
Section titled “remove()”remove(
id,params?):Promise<T>
Defined in: types.ts:76
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
Inherited from
Section titled “Inherited from”update()
Section titled “update()”update(
id,data,params?):Promise<T>
Defined in: types.ts:74
Parameters
Section titled “Parameters”D
params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>