ApiChangeType enum

represents the type of API change

Inheritance

• Object
• Enum
• ApiChangeType

Available extensions

• EnumName

Values

changeBreaking → const ApiChangeType

breaking change

const ApiChangeType._(isBreaking: true, requiresMinorBump: true)

changeCompatibleMinor → const ApiChangeType

non-breaking change that requires a minor bump

const ApiChangeType._(isBreaking: false, requiresMinorBump: true)

changeCompatiblePatch → const ApiChangeType

non-breaking change that only requires a patch bump

const ApiChangeType._(isBreaking: false, requiresMinorBump: false)

remove → const ApiChangeType

removal (breaking)

const ApiChangeType._(isBreaking: true, requiresMinorBump: true)

removeCompatibleMinor → const ApiChangeType

removal (non-breaking, rather rare)

const ApiChangeType._(isBreaking: false, requiresMinorBump: true)

removeCompatiblePatch → const ApiChangeType

removal (non-breaking, probably never used)

const ApiChangeType._(isBreaking: false, requiresMinorBump: false)

addCompatibleMinor → const ApiChangeType

non-breaking addition that requires a minor bump

const ApiChangeType._(isBreaking: false, requiresMinorBump: true)

addCompatiblePatch → const ApiChangeType

non-breaking addition that only requires a patch bump

const ApiChangeType._(isBreaking: false, requiresMinorBump: false)

addBreaking → const ApiChangeType

breaking addition (like adding a required parameter)

const ApiChangeType._(isBreaking: true, requiresMinorBump: true)

Properties

hashCode → int

The hash code for this object.

no setter, inherited

index → int

A numeric identifier for the enumerated value.

no setter, inherited

isBreaking → bool

determines if the change is breaking

final

name → String

Available on Enum, provided by the EnumName extension

The name of the enum value.

no setter

requiresMinorBump → bool

determines if the change requires a minor bump (if false then it requires a patch bump)

final

runtimeType → Type

A representation of the runtime type of the object.

no setter, inherited

Methods

noSuchMethod(Invocation invocation) → dynamic

Invoked when a nonexistent method or property is accessed.

inherited

toString() → String

A string representation of this object.

inherited

Operators

operator ==(Object other) → bool

The equality operator.

inherited

Constants

values → const List<ApiChangeType>

A constant List of the values in this enum, in order of their declaration.