Interface IMockStore

packages/mock/src/types.ts:84–216

};

export interface IMockStore {
  schema: GraphQLSchema;
  /**
   * Get a field value from the store for the given type, key and field
   * name — and optionally field arguments. If the field name is not given,
   * a reference to the type will be returned.
   *
   * If the the value for this field is not set, a value will be
   * generated according to field return type and mock functions.
   *
   * If the field's output type is a `ObjectType` (or list of `ObjectType`),
   * it will return a `Ref` (or array of `Ref`), ie a reference to an entity
   * in the store.
   *
   * Example:
   * ```ts
   * store.get('Query', 'ROOT', 'viewer');
   * > { $ref: { key: 'abc-737dh-djdjd', typeName: 'User' } }
   * store.get('User', 'abc-737dh-djdjd', 'name')
   * > "Hello World"
   * ```
   */
  get<KeyT extends KeyTypeConstraints = string, ReturnKeyT extends KeyTypeConstraints = string>(
    args: GetArgs<KeyT>,
  ): unknown | Ref<ReturnKeyT>;
  /**
   * Shorthand for `get({typeName, key, fieldName, fieldArgs})`.
   */
  get<KeyT extends KeyTypeConstraints = string, ReturnKeyT extends KeyTypeConstraints = string>(
    typeName: string,
    key: KeyT,
    fieldNameOrFieldNames: string | string[],
    fieldArgs?: string | { [argName: string]: any },
  ): unknown | Ref<ReturnKeyT>;
  /**
   * Get a reference to the type.
   */
  get<KeyT extends KeyTypeConstraints = string>(
    typeName: string,
    keyOrDefaultValue?: KeyT | { [fieldName: string]: any },
    defaultValue?: { [fieldName: string]: any },
  ): unknown | Ref<KeyT>;

  /**
   * Shorthand for `get({typeName: ref.$ref.typeName, key: ref.$ref.key, fieldName, fieldArgs})`
   * @param ref
   * @param fieldNameOrFieldNames
   * @param fieldArgs
   */
  get<KeyT extends KeyTypeConstraints = string, ReturnKeyT extends KeyTypeConstraints = string>(
    ref: Ref<KeyT>,
    fieldNameOrFieldNames: string | string[],
    fieldArgs?: string | { [argName: string]: any },
  ): unknown | Ref<ReturnKeyT>;

  /**
   * Set a field value in the store for the given type, key and field
   * name — and optionally field arguments.