Provides functions to execute resource services on the REST server
for the client. The resource service extensions must have been
installed previously on the REST server using the
config.resources#write function.
Methods
-
get(name, params, txid) → {ResultProvider}
-
Invokes the get() function in the resource service.
Parameters:
Name Type Argument Description namestring the name of the service paramsobject <optional>
an object in which each property has a variable name as a key and a number, string, or boolean value txidstring | transactions.Transaction <optional>
a string transaction id or Transaction object identifying an open multi-statement transaction Returns:
an object whose stream() function returns a stream that receives the response- Type
- ResultProvider
-
post(name, params, documents, txid) → {ResultProvider}
-
Invokes the post() function in the resource service.
Parameters:
Name Type Argument Description namestring the name of the service paramsobject <optional>
an object in which each property has a variable name as a key and a number, string, or boolean value documentsstring | object | Buffer | ReadableStream <optional>
any document content to send to the server txidstring | transactions.Transaction <optional>
a string transaction id or Transaction object identifying an open multi-statement transaction Returns:
an object whose stream() function returns a stream that receives the response- Type
- ResultProvider
-
put(name, params, documents, txid)
-
Invokes the put() function in the resource service.
Parameters:
Name Type Argument Description namestring the name of the service paramsobject <optional>
an object in which each property has a variable name as a key and a number, string, or boolean value documentsstring | object | Buffer | ReadableStream <optional>
any document content to send to the server txidstring | transactions.Transaction <optional>
a string transaction id or Transaction object identifying an open multi-statement transaction -
remove(name, params, txid)
-
Invokes the delete() function in the resource service.
Parameters:
Name Type Argument Description namestring the name of the service paramsobject <optional>
an object in which each property has a variable name as a key and a number, string, or boolean value txidstring | transactions.Transaction <optional>
a string transaction id or Transaction object identifying an open multi-statement transaction