ArraySpec class final

Specification for array/list types.

Inheritance

Constructors

ArraySpec({required TypeSpec items, int? minItems, int? maxItems, bool uniqueItems = false, List<Object>? defaultValue, String? description, bool nullable = false, List<Object>? examples, bool isDeprecated = false})
Creates a new ArraySpec.
const

Properties

defaultValue → List<Object>?
Default value.
final
description → String?
Optional description of this type.
finalinherited
examples → List<Object>?
Example values for documentation.
finalinherited
hashCode → int
The hash code for this object.
no setterinherited
isDeprecated → bool
Whether this type is deprecated.
finalinherited
items → TypeSpec
The type specification for array items.
final
maxItems → int?
Maximum number of items.
final
minItems → int?
Minimum number of items.
final
nullable → bool
Whether this type accepts null values.
finalinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
uniqueItems → bool
Whether items must be unique.
final

Methods

asNullable() → ArraySpec
Creates a copy of this spec with nullable set to true.
override
copyWith({TypeSpec? items, int? minItems, int? maxItems, bool? uniqueItems, List<Object>? defaultValue, String? description, bool? nullable, List<Object>? examples, bool? isDeprecated}) → ArraySpec
Creates a copy with the given modifications.
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toString() → String
A string representation of this object.
inherited
withDescription(String description) → ArraySpec
Creates a copy of this spec with the given description.
override

Operators

operator ==(Object other) → bool
The equality operator.
inherited