Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "graph/graphQL"

Index

Functions

enumValue

ingester

  • Prepare a GraphQL ingester SDL string for the register with the automation client.

    Ingester can be provided by the following options:

    • path: absolute or relative path to a .graphql file to load; if provided a relative
         path this will resolve the relative path to an absolute given the location of
         the calling script.
      
    • name: name of the .graphql file to load; this will walk up the directory structure
         starting a t the location of the calling script and look for a folder called
         'graphql'. Once that folder is found, by convention name is being looked for
         in the 'ingester' sub directory.
      

    Parameters

    Returns string

subscription

  • Prepare a GraphQL subscription string for the use with Apollo or EventHandlers.

    Subscription can be provided by the following options:

    • subscription: string containing the subscription GraphQL, or
    • path: absolute or relative path to a .graphql file to load; if provided a relative
         path this will resolve the relative path to an absolute given the location of
         the calling script.
      
    • name: name GraphQL subscription operation to load; this will walk up the directory
         structure starting at the location of the calling script and look for a folder
         called 'graphql'. Once that folder is found, the subscription named 'name' is
         being looked for.
      
    • fragmentsDir: location of fragment .graphql files
    • inline: remove any unneeded whitespace and line breaks from returned GraphQL string
    • variables: the variables to bind into the subscription
    • operationName: name of the subscription to use in the generated GraphQL string

    Parameters

    Returns string

subscriptionFromFile

  • subscriptionFromFile(path: string, current?: string, parameters?: object): string
  • Read a subscription from a file relative to the provided directory (or the module root by default) Note: Use __dirname to get the current directory of the calling script.

    Parameters

    • path: string
    • Default value current: string = appRoot.path
    • Default value parameters: object = {}

    Returns string

    DEPRECATED: use subscription() instead

Generated using TypeDoc