ServiceClient
Defined in: service-client.ts:35
Client-side counterpart of the server’s Service<T> — the same six method
names, dispatched as REST calls, plus the similar() vector-search
convention and real-time on()/off() service events over socket.io.
Type Parameters
Section titled “Type Parameters”T = unknown
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new ServiceClient<
T>(path,rest,sockets?,scheduler?):ServiceClient<T>
Defined in: service-client.ts:36
Parameters
Section titled “Parameters”string
sockets?
Section titled “sockets?”SocketManager
scheduler?
Section titled “scheduler?”Returns
Section titled “Returns”ServiceClient<T>
Accessors
Section titled “Accessors”realtime
Section titled “realtime”Get Signature
Section titled “Get Signature”get realtime():
boolean
Defined in: service-client.ts:118
True when the client was created with the socket option — on()/off() are available.
Returns
Section titled “Returns”boolean
Methods
Section titled “Methods”create()
Section titled “create()”create(
data,params?):Promise<T>
Defined in: service-client.ts:53
Parameters
Section titled “Parameters”Partial<T>
params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
find()
Section titled “find()”find(
params?):Promise<T[] |Paginated<T>>
Defined in: service-client.ts:43
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T[] | Paginated<T>>
get(
id,params?):Promise<T>
Defined in: service-client.ts:48
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
off(
event,handler):this
Defined in: service-client.ts:127
Parameters
Section titled “Parameters”handler
Section titled “handler”(data) => void
Returns
Section titled “Returns”this
on(
event,handler):this
Defined in: service-client.ts:122
Parameters
Section titled “Parameters”handler
Section titled “handler”(data) => void
Returns
Section titled “Returns”this
patch()
Section titled “patch()”patch(
id,data,params?):Promise<T>
Defined in: service-client.ts:63
Parameters
Section titled “Parameters”Partial<T>
params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
remove()
Section titled “remove()”remove(
id,params?):Promise<T>
Defined in: service-client.ts:68
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
similar()
Section titled “similar()”similar(
data,params?):Promise<T&object[]>
Defined in: service-client.ts:113
Vector-search convention (custom methods dispatch as POST /:service/:method).
The service must register similar in its methods — see VectorRepositoryService.
Parameters
Section titled “Parameters”params?
Section titled “params?”Returns
Section titled “Returns”Promise<T & object[]>
update()
Section titled “update()”update(
id,data,params?):Promise<T>
Defined in: service-client.ts:58
Parameters
Section titled “Parameters”Partial<T>
params?
Section titled “params?”Returns
Section titled “Returns”Promise<T>
upload()
Section titled “upload()”upload(
file,options?):Promise<T>
Defined in: service-client.ts:94
Upload a file as multipart/form-data to a service whose create (or, with options.id,
patch) runs @mantlejs/storage’s handleUpload(). Ordinary fields go before the file part,
which handleUpload() merges into context.data. Never batched — POST /batch is JSON-only.
Parameters
Section titled “Parameters”Blob
options?
Section titled “options?”UploadOptions = {}
Returns
Section titled “Returns”Promise<T>