Documentation

BreakingChangesFinder
in package

Table of Contents

BREAKING_CHANGE_ARG_CHANGED_KIND  = 'ARG_CHANGED_KIND'
BREAKING_CHANGE_ARG_REMOVED  = 'ARG_REMOVED'
BREAKING_CHANGE_DIRECTIVE_ARG_REMOVED  = 'DIRECTIVE_ARG_REMOVED'
BREAKING_CHANGE_DIRECTIVE_LOCATION_REMOVED  = 'DIRECTIVE_LOCATION_REMOVED'
BREAKING_CHANGE_DIRECTIVE_REMOVED  = 'DIRECTIVE_REMOVED'
BREAKING_CHANGE_FIELD_CHANGED_KIND  = 'FIELD_CHANGED_KIND'
BREAKING_CHANGE_FIELD_REMOVED  = 'FIELD_REMOVED'
BREAKING_CHANGE_IMPLEMENTED_INTERFACE_REMOVED  = 'IMPLEMENTED_INTERFACE_REMOVED'
BREAKING_CHANGE_INTERFACE_REMOVED_FROM_OBJECT  = 'IMPLEMENTED_INTERFACE_REMOVED'
BREAKING_CHANGE_REQUIRED_ARG_ADDED  = 'REQUIRED_ARG_ADDED'
BREAKING_CHANGE_REQUIRED_DIRECTIVE_ARG_ADDED  = 'REQUIRED_DIRECTIVE_ARG_ADDED'
BREAKING_CHANGE_REQUIRED_INPUT_FIELD_ADDED  = 'REQUIRED_INPUT_FIELD_ADDED'
BREAKING_CHANGE_TYPE_CHANGED_KIND  = 'TYPE_CHANGED_KIND'
BREAKING_CHANGE_TYPE_REMOVED  = 'TYPE_REMOVED'
BREAKING_CHANGE_TYPE_REMOVED_FROM_UNION  = 'TYPE_REMOVED_FROM_UNION'
BREAKING_CHANGE_VALUE_REMOVED_FROM_ENUM  = 'VALUE_REMOVED_FROM_ENUM'
DANGEROUS_CHANGE_ARG_DEFAULT_VALUE_CHANGED  = 'ARG_DEFAULT_VALUE_CHANGE'
DANGEROUS_CHANGE_IMPLEMENTED_INTERFACE_ADDED  = 'IMPLEMENTED_INTERFACE_ADDED'
DANGEROUS_CHANGE_INTERFACE_ADDED_TO_OBJECT  = 'IMPLEMENTED_INTERFACE_ADDED'
DANGEROUS_CHANGE_OPTIONAL_ARG_ADDED  = 'OPTIONAL_ARG_ADDED'
DANGEROUS_CHANGE_OPTIONAL_INPUT_FIELD_ADDED  = 'OPTIONAL_INPUT_FIELD_ADDED'
DANGEROUS_CHANGE_TYPE_ADDED_TO_UNION  = 'TYPE_ADDED_TO_UNION'
DANGEROUS_CHANGE_VALUE_ADDED_TO_ENUM  = 'VALUE_ADDED_TO_ENUM'
findAddedArgsForDirective()  : array<string|int, FieldArgument>
findAddedNonNullDirectiveArgs()  : mixed
findArgChanges()  : array<string, array<int, array<string, string>>>
Given two schemas, returns an Array containing descriptions of any breaking or dangerous changes in the newSchema related to arguments (such as removal or change of type of an argument, or a change in an argument's default value).
findBreakingChanges()  : array<string|int, array<string|int, string>>
Given two schemas, returns an Array containing descriptions of all the types of breaking changes covered by the other functions down below.
findDangerousChanges()  : array<string|int, array<string|int, string>>
Given two schemas, returns an Array containing descriptions of all the types of potentially dangerous changes covered by the other functions down below.
findFieldsThatChangedTypeOnInputObjectTypes()  : array<string, array<int, array<string, string>>>
findFieldsThatChangedTypeOnObjectOrInterfaceTypes()  : array<string|int, array<string|int, string>>
findInterfacesAddedToObjectTypes()  : array<string|int, array<string|int, string>>
findInterfacesRemovedFromObjectTypes()  : array<string|int, array<string|int, string>>
findRemovedArgsForDirectives()  : mixed
findRemovedDirectiveArgs()  : mixed
findRemovedDirectiveLocations()  : array<string|int, array<string|int, string>>
findRemovedDirectives()  : array<string|int, array<string|int, string>>
findRemovedLocationsForDirective()  : mixed
findRemovedTypes()  : array<string|int, array<string|int, string>>
Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing an entire type.
findTypesAddedToUnions()  : array<string|int, array<string|int, string>>
Given two schemas, returns an Array containing descriptions of any dangerous changes in the newSchema related to adding types to a union type.
findTypesRemovedFromUnions()  : array<string|int, array<string|int, string>>
Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing types from a union type.
findTypesThatChangedKind()  : array<string|int, array<string|int, string>>
Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to changing the type of a type.
findValuesAddedToEnums()  : array<string|int, array<string|int, string>>
Given two schemas, returns an Array containing descriptions of any dangerous changes in the newSchema related to adding values to an enum type.
findValuesRemovedFromEnums()  : array<string|int, array<string|int, string>>
Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing values from an enum type.
getArgumentMapForDirective()  : mixed
getDirectiveMapForSchema()  : mixed
isChangeSafeForInputObjectFieldOrFieldArg()  : bool
isChangeSafeForObjectOrInterfaceField()  : bool
typeKindName()  : string

Constants

BREAKING_CHANGE_ARG_CHANGED_KIND

public mixed BREAKING_CHANGE_ARG_CHANGED_KIND = 'ARG_CHANGED_KIND'

BREAKING_CHANGE_DIRECTIVE_ARG_REMOVED

public mixed BREAKING_CHANGE_DIRECTIVE_ARG_REMOVED = 'DIRECTIVE_ARG_REMOVED'

BREAKING_CHANGE_DIRECTIVE_LOCATION_REMOVED

public mixed BREAKING_CHANGE_DIRECTIVE_LOCATION_REMOVED = 'DIRECTIVE_LOCATION_REMOVED'

BREAKING_CHANGE_DIRECTIVE_REMOVED

public mixed BREAKING_CHANGE_DIRECTIVE_REMOVED = 'DIRECTIVE_REMOVED'

BREAKING_CHANGE_FIELD_CHANGED_KIND

public mixed BREAKING_CHANGE_FIELD_CHANGED_KIND = 'FIELD_CHANGED_KIND'

BREAKING_CHANGE_IMPLEMENTED_INTERFACE_REMOVED

public mixed BREAKING_CHANGE_IMPLEMENTED_INTERFACE_REMOVED = 'IMPLEMENTED_INTERFACE_REMOVED'

BREAKING_CHANGE_INTERFACE_REMOVED_FROM_OBJECT

public mixed BREAKING_CHANGE_INTERFACE_REMOVED_FROM_OBJECT = 'IMPLEMENTED_INTERFACE_REMOVED'
Tags
deprecated

use BREAKING_CHANGE_IMPLEMENTED_INTERFACE_REMOVED instead, will be removed in v15.0.0.

BREAKING_CHANGE_REQUIRED_ARG_ADDED

public mixed BREAKING_CHANGE_REQUIRED_ARG_ADDED = 'REQUIRED_ARG_ADDED'

BREAKING_CHANGE_REQUIRED_DIRECTIVE_ARG_ADDED

public mixed BREAKING_CHANGE_REQUIRED_DIRECTIVE_ARG_ADDED = 'REQUIRED_DIRECTIVE_ARG_ADDED'

BREAKING_CHANGE_REQUIRED_INPUT_FIELD_ADDED

public mixed BREAKING_CHANGE_REQUIRED_INPUT_FIELD_ADDED = 'REQUIRED_INPUT_FIELD_ADDED'

BREAKING_CHANGE_TYPE_CHANGED_KIND

public mixed BREAKING_CHANGE_TYPE_CHANGED_KIND = 'TYPE_CHANGED_KIND'

BREAKING_CHANGE_TYPE_REMOVED_FROM_UNION

public mixed BREAKING_CHANGE_TYPE_REMOVED_FROM_UNION = 'TYPE_REMOVED_FROM_UNION'

BREAKING_CHANGE_VALUE_REMOVED_FROM_ENUM

public mixed BREAKING_CHANGE_VALUE_REMOVED_FROM_ENUM = 'VALUE_REMOVED_FROM_ENUM'

DANGEROUS_CHANGE_ARG_DEFAULT_VALUE_CHANGED

public mixed DANGEROUS_CHANGE_ARG_DEFAULT_VALUE_CHANGED = 'ARG_DEFAULT_VALUE_CHANGE'

DANGEROUS_CHANGE_IMPLEMENTED_INTERFACE_ADDED

public mixed DANGEROUS_CHANGE_IMPLEMENTED_INTERFACE_ADDED = 'IMPLEMENTED_INTERFACE_ADDED'

DANGEROUS_CHANGE_INTERFACE_ADDED_TO_OBJECT

public mixed DANGEROUS_CHANGE_INTERFACE_ADDED_TO_OBJECT = 'IMPLEMENTED_INTERFACE_ADDED'
Tags
deprecated

use DANGEROUS_CHANGE_IMPLEMENTED_INTERFACE_ADDED instead, will be removed in v15.0.0.

DANGEROUS_CHANGE_OPTIONAL_ARG_ADDED

public mixed DANGEROUS_CHANGE_OPTIONAL_ARG_ADDED = 'OPTIONAL_ARG_ADDED'

DANGEROUS_CHANGE_OPTIONAL_INPUT_FIELD_ADDED

public mixed DANGEROUS_CHANGE_OPTIONAL_INPUT_FIELD_ADDED = 'OPTIONAL_INPUT_FIELD_ADDED'

DANGEROUS_CHANGE_TYPE_ADDED_TO_UNION

public mixed DANGEROUS_CHANGE_TYPE_ADDED_TO_UNION = 'TYPE_ADDED_TO_UNION'

DANGEROUS_CHANGE_VALUE_ADDED_TO_ENUM

public mixed DANGEROUS_CHANGE_VALUE_ADDED_TO_ENUM = 'VALUE_ADDED_TO_ENUM'

Methods

findAddedNonNullDirectiveArgs()

public static findAddedNonNullDirectiveArgs(Schema $oldSchema, Schema $newSchema) : mixed
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
mixed —

findArgChanges()

Given two schemas, returns an Array containing descriptions of any breaking or dangerous changes in the newSchema related to arguments (such as removal or change of type of an argument, or a change in an argument's default value).

public static findArgChanges(Schema $oldSchema, Schema $newSchema) : array<string, array<int, array<string, string>>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string, array<int, array<string, string>>> —

findBreakingChanges()

Given two schemas, returns an Array containing descriptions of all the types of breaking changes covered by the other functions down below.

public static findBreakingChanges(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findDangerousChanges()

Given two schemas, returns an Array containing descriptions of all the types of potentially dangerous changes covered by the other functions down below.

public static findDangerousChanges(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findFieldsThatChangedTypeOnInputObjectTypes()

public static findFieldsThatChangedTypeOnInputObjectTypes(Schema $oldSchema, Schema $newSchema) : array<string, array<int, array<string, string>>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string, array<int, array<string, string>>> —

findFieldsThatChangedTypeOnObjectOrInterfaceTypes()

public static findFieldsThatChangedTypeOnObjectOrInterfaceTypes(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findInterfacesAddedToObjectTypes()

public static findInterfacesAddedToObjectTypes(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findInterfacesRemovedFromObjectTypes()

public static findInterfacesRemovedFromObjectTypes(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findRemovedDirectiveArgs()

public static findRemovedDirectiveArgs(Schema $oldSchema, Schema $newSchema) : mixed
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
mixed —

findRemovedDirectiveLocations()

public static findRemovedDirectiveLocations(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findRemovedDirectives()

public static findRemovedDirectives(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findRemovedTypes()

Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing an entire type.

public static findRemovedTypes(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findTypesAddedToUnions()

Given two schemas, returns an Array containing descriptions of any dangerous changes in the newSchema related to adding types to a union type.

public static findTypesAddedToUnions(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findTypesRemovedFromUnions()

Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing types from a union type.

public static findTypesRemovedFromUnions(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findTypesThatChangedKind()

Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to changing the type of a type.

public static findTypesThatChangedKind(Schema $schemaA, Schema $schemaB) : array<string|int, array<string|int, string>>
Parameters
$schemaA : Schema
$schemaB : Schema
Return values
array<string|int, array<string|int, string>> —

findValuesAddedToEnums()

Given two schemas, returns an Array containing descriptions of any dangerous changes in the newSchema related to adding values to an enum type.

public static findValuesAddedToEnums(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

findValuesRemovedFromEnums()

Given two schemas, returns an Array containing descriptions of any breaking changes in the newSchema related to removing values from an enum type.

public static findValuesRemovedFromEnums(Schema $oldSchema, Schema $newSchema) : array<string|int, array<string|int, string>>
Parameters
$oldSchema : Schema
$newSchema : Schema
Return values
array<string|int, array<string|int, string>> —

getDirectiveMapForSchema()

private static getDirectiveMapForSchema(Schema $schema) : mixed
Parameters
$schema : Schema
Return values
mixed —

isChangeSafeForInputObjectFieldOrFieldArg()

private static isChangeSafeForInputObjectFieldOrFieldArg(Type $oldType, Type $newType) : bool
Parameters
$oldType : Type
$newType : Type
Return values
bool —

isChangeSafeForObjectOrInterfaceField()

private static isChangeSafeForObjectOrInterfaceField(Type $oldType, Type $newType) : bool
Parameters
$oldType : Type
$newType : Type
Return values
bool —

typeKindName()

private static typeKindName(Type $type) : string
Parameters
$type : Type
Tags
throws
TypeError
Return values
string —

Search results