Interface: CypherFn

Defined in: lang-cypher/src/language/language.ts:64

Extension of Fn for Cypher built-in functions that may require graph adapter injection.

Extends

• Fn

Properties

addAdapterCtx?

optional addAdapterCtx?: boolean

Defined in: lang-cypher/src/language/language.ts:66

When true, the runtime prepends an AdapterCtxArg as the first argument before calling impl.

---

impl

impl: (...args) => any

Defined in: core/dist/extension.d.ts:18

Implementation function; receives argument values and returns the result.

Parameters

Parameter	Type
...args	any[]

Returns

any

Inherited from

Fn.impl

---

name

name: string

Defined in: core/dist/extension.d.ts:12

Unique name used to look up this function.

Inherited from

Fn.name

---

outputSchema?

optional outputSchema?: ASTIdentifier[]

Defined in: core/dist/extension.d.ts:16

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

Inherited from

Fn.outputSchema

---

pure?

optional pure?: boolean

Defined in: core/dist/extension.d.ts:20

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

Inherited from

Fn.pure

---

schema?

optional schema?: string | symbol

Defined in: core/dist/extension.d.ts:14

Schema (name prefix) of the function.

Inherited from

Fn.schema