Class GraphQlApi<RESOLVERS>

Type Parameters

  • RESOLVERS

Hierarchy

Constructors

Properties

_functions: {
    [operationId: string]: LambdaFunction;
} = {}

Type declaration

api: GraphqlApi
apiDomainName?: string
apiFQDN?: string
apiHostName?: string
hostedZone?: IHostedZone
node: Node

The tree node.

tableDataSource?: DynamoDbDataSource

Methods

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE
    • Optional options: JsResolverOptions
      Optional

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE
    • Optional options: Omit<VtlResolverOptions, "dataSource">
      Optional

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE
    • dataSource: BaseDataSource
    • Optional options: JsResolverOptions
      Optional

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE

    Returns LambdaFunction

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    Returns void

  • Parameters

    • entryFile: string
    • typeName: string
    • fieldName: string

    Returns void

  • Parameters

    • fn: JsResolverConfig
    • typeName: string
    • fieldName: string

    Returns void

  • getFunctionForOperation

    Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • fieldName: keyof FIELDTYPE

    Returns LambdaFunction

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • grantee: IGrantable
    • typeName: TYPE
    • Rest ...fieldNames: (keyof FIELDTYPE)[]
      Rest

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • Rest ...fieldNames: (keyof FIELDTYPE)[]
      Rest

    Returns void

  • Type Parameters

    • TYPE extends string | number | symbol

    • FIELDTYPE extends {}

    Parameters

    • typeName: TYPE
    • Rest ...fieldNames: (keyof FIELDTYPE)[]
      Rest

    Returns void

  • Parameters

    • data: string
    • vars: {
          [name: string]: string;
      } = {}
      • [name: string]: string

    Returns string

  • Returns a string representation of this construct.

    Returns string

  • Checks if x is a construct.

    Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

    Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

    Parameters

    • x: any

      Any object

    Returns x is Construct

    true if x is an object created from a class which extends Construct.

Generated using TypeDoc