Interface: Fn

Defined in: packages/core/src/extension.ts:16

A function used in queries. For example, string manipulation functions.

Extended by

• XQueryFn
• CypherFn

Properties

impl

impl: (...args) => any

Defined in: packages/core/src/extension.ts:24

Implementation function; receives argument values and returns the result.

Parameters

Parameter	Type
...args	any[]

Returns

any

---

name

name: string

Defined in: packages/core/src/extension.ts:18

Unique name used to look up this function.

---

outputSchema?

optional outputSchema?: ASTIdentifier[]

Defined in: packages/core/src/extension.ts:22

If the function is used as a tuple source, this is the schema of its output.

---

pure?

optional pure?: boolean

Defined in: packages/core/src/extension.ts:26

No side effects, same output for same input (careful: () => ({}) is not pure).

---

schema?

optional schema?: string | symbol

Defined in: packages/core/src/extension.ts:20

Schema (name prefix) of the function.