Class GeneratedListField

A list of values or objects, used in generated APIs.

Hierarchy

GeneratedListField

Index

Constructors

Properties

Methods

contentsList contentsString toString

Constructors

constructor

new GeneratedListField(__namedParameters: GeneratedListFieldConstructor): GeneratedListField
Parameters
- __namedParameters: GeneratedListFieldConstructor
Returns GeneratedListField
- Defined in src/parsing/generated/generatedList.ts:19

Properties

`Optional` pageId

pageId?: number

Id of the page the object was found on.

values

values: (StringField | GeneratedObjectField)[]

List of word values.

Methods

contentsList

contentsList(): string[]
Returns an array of the contents of all values.

Returns string[]
- Defined in src/parsing/generated/generatedList.ts:44

contentsString

contentsString(separator?: string): string
Return a string representation of all values.

Returns
string representation.
Parameters
- separator: string = " "
  
  Character(s) to use when concatenating fields.
Returns string
- Defined in src/parsing/generated/generatedList.ts:53

toString

toString(): string
Default string representation.

Returns string
- Defined in src/parsing/generated/generatedList.ts:60

Generated using TypeDoc