Options
All
  • Public
  • Public/Protected
  • All
Menu

Index

Enumerations

Classes

Type aliases

Type aliases

Maybe

Maybe<T>: T | undefined

Type parameters

  • T

Scalars

Scalars: { Boolean: boolean; Coordinates: any; Date: any; DateTime: any; DurationInterval: any; Email: any; Float: number; ID: string; Int: number; Money: any; NaiveDateTime: any; PhoneNumber: any; QueryString: any; String: string; Tz: any; Url: any }

All built-in and custom scalars, mapped to their actual values

Type declaration

  • Boolean: boolean
  • Coordinates: any

    Represents a set of geographical coordinates

  • Date: any

    The Date scalar type represents a timezone agnostic date, formatted as an ISO8601 date string, i.e. YYYY-MM-DD.

  • DateTime: any

    The DateTime scalar type represents a datetime formatted as an ISO8601 string.

  • DurationInterval: any

    The Interval scalar type represents a time interval, formatted as an ISO8601 duration string.

  • Email: any

    Email address validated as an RFC 5322 addr-spec.

    See https://tools.ietf.org/html/rfc5322#section-3.4.1 for more details and https://tools.ietf.org/html/rfc3696#section-3 for an informational summary.

  • Float: number
  • ID: string
  • Int: number
  • Money: any

    Represents an amount of money as an integer of the smallest currency unit.

    For example, 1 USD is 100 since the cent is the smallest currency unit. Similarly, 1 JPY is 1 because the Japanese yen is a zero-decimal currency. For more information, see the ISO 4217 standard.

    The applicable currency is specified separately.

  • NaiveDateTime: any

    The NaiveDateTime scalar type represents a datetime formatted as an ISO 8601 string, without an associated time zone.

  • PhoneNumber: any

    The PhoneNumber scalar type represents a phone number formatted following the E.164 internationally recognized standard.

  • QueryString: any

    A String query is a text search made up of values and comparison operators.

    Supported value types:

    • Field name
    • String
    • Boolean
    • Number (float/int)
    • DateTime - formatted as an ISO 8601 string

    We also support 'IS NULL' and 'IS NOT NULL' operators.

    Examples:

    "startAt <= '2020-01-01T00:00:00'

    "quantity > 0"

    "categoryId IS NULL"

    Comparisons ( ) can be combined through the 'AND' and 'OR' operators.

    Examples:

    "endAt < '2020-01-01T00:00:00' AND cancelled = true"

    Create precedence by surrounding comparisons with parenthesis.

    Note: Strings and field names are case sensitive.

  • String: string
  • Tz: any

    Represents a time zone as a tz database (a.k.a. tzdata, IANA, Olson) time zone name. See https://en.wikipedia.org/wiki/Tz_database for more information.

  • Url: any

    Represents an absolute URL as defined by RFC3986

Generated using TypeDoc