Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "aql"

import { aql } from "arangojs/aql";

The "aql" module provides the aql template string handler and helper functions, as well as associated types and interfaces for TypeScript.

The aql function and namespace is also re-exported by the "index" module.

Index

Namespaces

Interfaces

Type aliases

Functions

Type aliases

AqlValue

AqlValue: ArangoCollection | GeneratedAqlQuery | AqlLiteral | string | number | boolean | null | undefined | object | any[]

A value that can be used in an AQL template string or passed to an AQL helper function.

Functions

isAqlLiteral

  • isAqlLiteral(literal: any): literal is AqlLiteral
  • Indicates whether the given value is an AqlLiteral.

    Parameters

    • literal: any

      A value that might be an AqlLiteral.

    Returns literal is AqlLiteral

isAqlQuery

  • isAqlQuery(query: any): query is AqlQuery
  • Indicates whether the given value is an AqlQuery.

    Parameters

    • query: any

      A value that might be an AqlQuery.

    Returns query is AqlQuery

Generated using TypeDoc