faunadb/src/types/query.d.ts

FaunaDB Javascript driver for Node.JS and Browsers

import Expr from './Expr'

type ExprVal = Expr | string | number | boolean | { [key: string]: any }
type ExprArg = ExprVal | Array<ExprVal>
export type Lambda = (...vars: any[]) => Expr

export function Ref(ref: ExprArg, id?: ExprArg): Expr
export function Bytes(bytes: ExprArg | ArrayBuffer | Uint8Array): Expr
export function Abort(msg: ExprArg): Expr
export function At(timestamp: ExprArg, expr: ExprArg): Expr
export function Let(vars: ExprArg, in_expr: ExprArg | null): Expr
export function Var(varName: ExprArg): Expr
export function If(
  condition: ExprArg,
  then: ExprArg | null,
  _else: ExprArg | null
): Expr
export function Do(...args: ExprArg[]): Expr
export function Object(fields: ExprArg): Expr
export function Lambda(f: Lambda): Expr
export function Lambda(var_name: ExprArg, expr: ExprArg): Expr
export function Call(ref: ExprArg, ...args: ExprArg[]): Expr
export function Query(lambda: ExprArg | Lambda): Expr
export function Map(collection: ExprArg, lambda_expr: ExprArg | Lambda): Expr
export function Merge(
  object: ExprArg,
  values: ExprArg,
  resolver?: Expr | Lambda
): Expr
export function Foreach(
  collection: ExprArg,
  lambda_expr: ExprArg | Lambda
): Expr
export function Filter(collection: ExprArg, lambda_expr: ExprArg | Lambda): Expr
export function Take(number: ExprArg, collection: ExprArg): Expr
export function Drop(number: ExprArg, collection: ExprArg): Expr
export function Prepend(elements: ExprArg, collection: ExprArg): Expr
export function Append(elements: ExprArg, collection: ExprArg): Expr
export function IsEmpty(collection: ExprArg): Expr
export function IsNonEmpty(collection: ExprArg): Expr
export function IsNumber(expr: ExprArg | null): Expr
export function IsDouble(expr: ExprArg | null): Expr
export function IsInteger(expr: ExprArg | null): Expr
export function IsBoolean(expr: ExprArg | null): Expr
export function IsNull(expr: ExprArg | null): Expr
export function IsBytes(expr: ExprArg | null): Expr
export function IsTimestamp(expr: ExprArg | null): Expr
export function IsDate(expr: ExprArg | null): Expr
export function IsString(expr: ExprArg | null): Expr
export function IsArray(expr: ExprArg | null): Expr
export function IsObject(expr: ExprArg | null): Expr
export function IsRef(expr: ExprArg | null): Expr
export function IsSet(expr: ExprArg | null): Expr
export function IsDoc(expr: ExprArg | null): Expr
export function IsLambda(expr: ExprArg | null): Expr
export function IsCollection(expr: ExprArg | null): Expr
export function IsDatabase(expr: ExprArg | null): Expr
export function IsIndex(expr: ExprArg | null): Expr
export function IsFunction(expr: ExprArg | null): Expr
export function IsKey(expr: ExprArg | null): Expr
export function IsToken(expr: ExprArg | null): Expr
export function IsCredentials(expr: ExprArg | null): Expr
export function IsRole(expr: ExprArg | null): Expr

export function Get(ref: ExprArg, ts?: ExprArg): Expr
export function KeyFromSecret(secret: ExprArg): Expr
export function Reduce(
  lambda: ExprArg,
  initial: ExprArg,
  collection: ExprArg
): Expr
export function Paginate(set: ExprArg, opts?: object): Expr
export function Exists(ref: ExprArg, ts?: ExprArg): Expr

export function Create(collection_ref: ExprArg, params?: ExprArg): Expr
export function Update(ref: ExprArg, params: ExprArg): Expr
export function Replace(ref: ExprArg, params: ExprArg): Expr
export function Delete(ref: ExprArg): Expr
export function Insert(
  ref: ExprArg,
  ts: ExprArg,
  action: ExprArg,
  params: ExprArg
): Expr
export function Remove(ref: ExprArg, ts: ExprArg, action: ExprArg): Expr
export function CreateClass(params: ExprArg): Expr
export function CreateCollection(params: ExprArg): Expr
export function CreateDatabase(params: ExprArg): Expr
export function CreateIndex(params: ExprArg): Expr
export function CreateKey(params: ExprArg): Expr
export function CreateFunction(params: ExprArg): Expr
export function CreateRole(params: ExprArg): Expr
export function CreateAccessProvider(params: ExprArg): Expr

export function Singleton(ref: ExprArg): Expr
export function Events(ref_set: ExprArg): Expr
export function Match(index: ExprArg, ...terms: ExprArg[]): Expr
export function Union(...sets: ExprArg[]): Expr
export function Intersection(...sets: ExprArg[]): Expr
export function Difference(...sets: ExprArg[]): Expr
export function Distinct(set: ExprArg): Expr
export function Join(source: ExprArg, target: ExprArg | Lambda): Expr

export function Range(
  set: ExprArg,
  from: ExprArg | null,
  to: ExprArg | null
): Expr
export function Login(ref: ExprArg, params: ExprArg): Expr
export function Logout(delete_tokens: ExprArg): Expr
export function Identify(ref: ExprArg, password: ExprArg): Expr
export function Identity(): Expr
export function CurrentIdentity(): Expr
export function HasIdentity(): Expr
export function HasCurrentIdentity(): Expr
export function CurrentToken(): Expr
export function HasCurrentToken(): Expr

export function Concat(strings: ExprArg, separator?: ExprArg): Expr
export function Casefold(string: ExprArg, normalizer?: ExprArg): Expr
export function ContainsStr(value: ExprArg, search: ExprArg): Expr
export function ContainsStrRegex(value: ExprArg, pattern: ExprArg): Expr
export function StartsWith(value: ExprArg, search: ExprArg): Expr
export function EndsWith(value: ExprArg, search: ExprArg): Expr
export function RegexEscape(value: ExprArg): Expr
export function FindStr(value: ExprArg, find: ExprArg, start?: ExprArg): Expr
export function FindStrRegex(
  value: ExprArg,
  find: ExprArg,
  start?: ExprArg,
  numResults?: ExprArg
): Expr
export function Length(expr: ExprArg): Expr
export function LowerCase(expr: ExprArg): Expr
export function LTrim(expr: ExprArg): Expr
export function NGram(terms: ExprArg, min?: ExprArg, max?: ExprArg): Expr
export function Repeat(expr: ExprArg, number?: ExprArg): Expr
export function ReplaceStr(expr: ExprArg, find: ExprArg, replace: ExprArg): Expr
export function ReplaceStrRegex(
  expr: ExprArg,
  find: ExprArg,
  replace: ExprArg,
  first?: ExprArg
): Expr
export function RTrim(expr: ExprArg): Expr
export function Space(expr: ExprArg): Expr
export function SubString(
  expr: ExprArg,
  start?: ExprArg,
  length?: ExprArg
): Expr
export function TitleCase(value: ExprArg): Expr
export function Trim(expr: ExprArg): Expr
export function UpperCase(expr: ExprArg): Expr
export function Format(string: ExprArg, values: ExprArg): Expr

export function Time(string: ExprArg): Expr
export function Epoch(number: ExprArg, unit: ExprArg): Expr
export function TimeAdd(base: ExprArg, offset: ExprArg, unit: ExprArg): Expr
export function TimeSubtract(
  base: ExprArg,
  offset: ExprArg,
  unit: ExprArg
): Expr
export function TimeDiff(start: ExprArg, finish: ExprArg, unit: ExprArg): Expr
export function Date(string: ExprArg): Expr
export function Now(): Expr
export function DayOfWeek(expr: ExprArg): Expr
export function DayOfYear(expr: ExprArg): Expr
export function DayOfMonth(expr: ExprArg): Expr
export function Hour(expr: ExprArg): Expr
export function Minute(expr: ExprArg): Expr
export function Second(expr: ExprArg): Expr
export function Year(expr: ExprArg): Expr
export function Month(expr: ExprArg): Expr

export function NextId(): Expr
export function NewId(): Expr
export function Database(name: ExprArg, scope?: ExprArg): Expr
export function Index(name: ExprArg, scope?: ExprArg): Expr
export function Class(name: ExprArg, scope?: ExprArg): Expr
export function Collection(name: ExprArg, scope?: ExprArg): Expr
export function Function(name: ExprArg, scope?: ExprArg): Expr
export function Role(name: ExprArg, scope?: ExprArg): Expr
export function AccessProviders(scope?: ExprArg): Expr
export function Databases(scope?: ExprArg): Expr
export function Classes(scope?: ExprArg): Expr
export function Collections(scope?: ExprArg): Expr
export function Indexes(scope?: ExprArg): Expr
export function Functions(scope?: ExprArg): Expr
export function Roles(scope?: ExprArg): Expr
export function Keys(scope?: ExprArg): Expr
export function Tokens(scope?: ExprArg): Expr
export function Credentials(scope?: ExprArg): Expr
export function Equals(...args: (ExprArg | null)[]): Expr
export function Contains(path: ExprArg, _in: ExprArg): Expr
export function Select(
  path: ExprArg,
  from: ExprArg,
  _default?: ExprArg | null
): Expr
export function SelectAll(path: ExprArg, from: ExprArg): Expr
export function Abs(expr: ExprArg): Expr
export function Add(...args: ExprArg[]): Expr
export function BitAnd(...args: ExprArg[]): Expr
export function BitNot(expr: ExprArg): Expr
export function BitOr(...args: ExprArg[]): Expr
export function BitXor(...args: ExprArg[]): Expr
export function Ceil(expr: ExprArg): Expr
export function Divide(...args: ExprArg[]): Expr
export function Floor(expr: ExprArg): Expr
export function Max(...args: ExprArg[]): Expr
export function Min(...args: ExprArg[]): Expr
export function Modulo(...args: ExprArg[]): Expr
export function Multiply(...args: ExprArg[]): Expr
export function Round(value: ExprArg, precision?: ExprArg): Expr
export function Subtract(...args: ExprArg[]): Expr
export function Sign(expr: ExprArg): Expr
export function Sqrt(expr: ExprArg): Expr
export function Trunc(value: ExprArg, precision?: ExprArg): Expr
export function Count(expr: ExprArg): Expr
export function Sum(expr: ExprArg): Expr
export function Mean(expr: ExprArg): Expr
export function Any(expr: ExprArg): Expr
export function All(expr: ExprArg): Expr
export function Acos(expr: ExprArg): Expr
export function Asin(expr: ExprArg): Expr
export function Atan(expr: ExprArg): Expr
export function Cos(expr: ExprArg): Expr
export function Cosh(expr: ExprArg): Expr
export function Degrees(expr: ExprArg): Expr
export function Exp(expr: ExprArg): Expr
export function Hypot(value: ExprArg, exp?: ExprArg): Expr
export function Ln(expr: ExprArg): Expr
export function Log(expr: ExprArg): Expr
export function Pow(value: ExprArg, exp?: ExprArg): Expr
export function Radians(expr: ExprArg): Expr
export function Sin(expr: ExprArg): Expr
export function Sinh(expr: ExprArg): Expr
export function Tan(expr: ExprArg): Expr
export function Tanh(expr: ExprArg): Expr
export function LT(...args: ExprArg[]): Expr
export function LTE(...args: ExprArg[]): Expr
export function GT(...args: ExprArg[]): Expr
export function GTE(...args: ExprArg[]): Expr
export function And(...args: ExprArg[]): Expr
export function Or(...args: ExprArg[]): Expr
export function Not(bool: ExprArg): Expr

export function ToString(expr: ExprArg | null): Expr
export function ToNumber(expr: ExprArg): Expr
export function ToObject(expr: ExprArg): Expr
export function ToArray(expr: ExprArg): Expr
export function ToDouble(expr: ExprArg): Expr
export function ToInteger(expr: ExprArg): Expr
export function ToTime(expr: ExprArg): Expr
export function ToDate(expr: ExprArg): Expr
export function ToSeconds(expr: ExprArg): Expr
export function ToMillis(expr: ExprArg): Expr
export function ToMicros(expr: ExprArg): Expr

export function MoveDatabase(from: ExprArg, to: ExprArg): Expr
export function Documents(collection: ExprArg): Expr
export function ContainsPath(path: ExprArg, _in: ExprArg): Expr
export function ContainsField(field: string, _in: ExprArg): Expr
export function ContainsValue(value: ExprArg | null, _in: ExprArg): Expr
export function Reverse(expr: ExprArg): Expr

export function AccessProvider(name: ExprArg): Expr