Namespace: transforms

transforms

Provides functions to maintain transform extension on the REST server for the client. The client must have been created for a user with the rest-admin role.

Methods


list() → {ResultProvider}

Lists the transforms installed on the server.
Since:
  • 1.0
Returns:
an object whose result() function takes a success callback that receives the list of transforms installed on the server
Type
ResultProvider

read(name) → {ResultProvider}

Reads the source for a transform installed on the server.
Parameters:
Name Type Description
name string the name of an installed transform
Since:
  • 1.0
Returns:
an object whose result() function takes a success callback that receives the source code
Type
ResultProvider

remove(name)

Deletes a transform from the server.
Parameters:
Name Type Description
name string the name of the transform
Since:
  • 1.0

write(name, format, source)

Installs a transform on the server.
Parameters:
Name Type Description
name string the name of the transform
format string a value from the javascript|xquery|xslt enumeration
source object | string the source for the transform
Since:
  • 1.0
Copyright 2014-2017 MarkLogic Corporation Documentation generated by JSDoc 3.4.3 on 2017-09-25T11:58:55-07:00 using the DocStrap template.