The Guild LogoThe Guild Monogram

Search docs

Search icon

Products by The Guild

Products

Hive logoHive blurred logo

Hive

Schema Registry for your GraphQL Workflows

Skip to main content

Interface: SnapshotTransformConfig

types/src.YamlConfig.SnapshotTransformConfig

Configuration for Snapshot extension

Table of contents#

Properties#

Properties#

apply#

apply: string[]

Resolver to be applied For example; apply:

- Query.* <- * will apply this extension to all fields of Query type
- Mutation.someMutationButProbablyYouWontNeedIt

Defined in#

packages/types/src/config.ts:1266


if#

Optional if: string | boolean

Expression for when to activate this extension. Value can be a valid JS expression string or a boolean (Any of: String, Boolean)

Defined in#

packages/types/src/config.ts:1258


outputDir#

outputDir: string

Path to the directory of the generated snapshot files

Defined in#

packages/types/src/config.ts:1270


respectSelectionSet#

Optional respectSelectionSet: boolean

Take snapshots by respecting the requested selection set. This might be needed for the handlers like Postgraphile or OData that rely on the incoming GraphQL operation.

Defined in#

packages/types/src/config.ts:1275