Namespace: transforms

transforms

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, transformParams)

Installs a transform on the server.

Parameters:

Name	Type	Argument	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
transformParams	object	<optional>	an object mapping parameter names to their XQuery SequenceType declarations (including cardinality such as *, ?, etc.)

Since:

• 1.0