Class VariableList<T>

A specialized list for managing variables, extending the PropertyList class.

Type Parameters

T extends Variable
The type of variable that extends the Variable base class.

Hierarchy (View Summary)

PropertyList<T>
- VariableList

Index

Constructors

constructor

Properties

list parent typeClass

Constructors

constructor

new VariableList<T extends Variable>(
parent: undefined | PropertyList<T>,
populate: T[],
): VariableList<T>
Constructs a new instance of the class.
Type Parameters
- T extends Variable
Parameters
- parent: undefined | PropertyList<T>
  The parent PropertyList instance, or undefined if there is no parent.
- populate: T[]
  An array of items of type Variable used to populate the list.
Returns VariableList<T>
Overrides PropertyList.constructor
- Defined in packages/insomnia-scripting-environment/src/objects/variables.ts:124

Properties

`Protected`list

list: T[] = []

`Protected`parent

parent: undefined | Property | PropertyList<any>

`Protected`typeClass

typeClass: { _index?: string }

Methods

add

add(item: T): void
Parameters
- item: T
Returns void
Inherited from PropertyList.add
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:357

all

all(): { [k: string]: any }[]
Returns { [k: string]: any }[]
Inherited from PropertyList.all
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:361

append

append(item: T): void
Parameters
- item: T
Returns void
Inherited from PropertyList.append
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:365

assimilate

assimilate(source: PropertyList<T> | T[], prune?: boolean): void
Parameters
- source: PropertyList<T> | T[]
- Optionalprune: boolean
Returns void
Inherited from PropertyList.assimilate
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:369

clear

clear(): void
Returns void
Inherited from PropertyList.clear
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:382

count

count(): number
Returns number
Inherited from PropertyList.count
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:386

each

each(iterator: (item: T) => void, context: object): void
Parameters
- iterator: (item: T) => void
- context: object
Returns void
Inherited from PropertyList.each
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:390

eachParent

eachParent(
_iterator: (parent: Property, prev: Property) => void,
_context?: object,
): void
Parameters
- _iterator: (parent: Property, prev: Property) => void
- Optional_context: object
Returns void
Inherited from PropertyList.eachParent
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:403

filter

filter(rule: (item: T) => boolean, context: object): T[]
Parameters
- rule: (item: T) => boolean
- context: object
Returns T[]
Inherited from PropertyList.filter
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:407

find

find(rule: (item: T) => boolean, context?: object): undefined | T
Parameters
- rule: (item: T) => boolean
- Optionalcontext: object
Returns undefined | T
Inherited from PropertyList.find
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:419

get

get(key: string): undefined | T
Parameters
- key: string
Returns undefined | T
Inherited from PropertyList.get
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:431

has

has(item: T, _value?: any): boolean
Parameters
- item: T
- Optional_value: any
Returns boolean
Inherited from PropertyList.has
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:437

idx

idx(index: number): undefined | T
Parameters
- index: number
Returns undefined | T
Inherited from PropertyList.idx
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:442

indexOf

indexOf(item: string | T): number
Parameters
- item: string | T
Returns number
Inherited from PropertyList.indexOf
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:449

insert

insert(item: T, before?: number): void
Parameters
- item: T
- Optionalbefore: number
Returns void
Inherited from PropertyList.insert
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:466

insertAfter

insertAfter(item: T, after?: number): void
Parameters
- item: T
- Optionalafter: number
Returns void
Inherited from PropertyList.insertAfter
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:474

map

map(iterator: (item: T) => any, context: object): any[]
Parameters
- iterator: (item: T) => any
- context: object
Returns any[]
Inherited from PropertyList.map
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:482

one

one(id: string): undefined | T
Parameters
- id: string
Returns undefined | T
Inherited from PropertyList.one
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:493

populate

populate(items: T[]): void
Parameters
- items: T[]
Returns void
Inherited from PropertyList.populate
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:506

prepend

prepend(item: T): void
Parameters
- item: T
Returns void
Inherited from PropertyList.prepend
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:510

reduce

reduce(
    iterator: (acc: any, item: T) => any,
    accumulator: any,
    context: object,
): any
Parameters
- iterator: (acc: any, item: T) => any
- accumulator: any
- context: object
Returns any
Inherited from PropertyList.reduce
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:514

remove

remove(predicate: T | ((item: T) => boolean), context: object): void
Parameters
- predicate: T | ((item: T) => boolean)
- context: object
Returns void
Inherited from PropertyList.remove
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:525

repopulate

repopulate(items: T[]): void
Parameters
- items: T[]
Returns void
Inherited from PropertyList.repopulate
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:534

toObject

toObject(
    _excludeDisabled?: boolean,
    _caseSensitive?: boolean,
    _multiValue?: boolean,
    _sanitizeKeys?: boolean,
): { [k: string]: any }[]
Parameters
- Optional_excludeDisabled: boolean
- Optional_caseSensitive: boolean
- Optional_multiValue: boolean
- Optional_sanitizeKeys: boolean
Returns { [k: string]: any }[]
Inherited from PropertyList.toObject
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:541

toString

toString(): string
Returns string
Inherited from PropertyList.toString
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:547

upsert

upsert(item: T): boolean
Parameters
- item: T
Returns boolean
Inherited from PropertyList.upsert
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:552

`Static`isPropertyList

isPropertyList(obj: object): boolean
Parameters
- obj: object
Returns boolean
Inherited from PropertyList.isPropertyList
- Defined in packages/insomnia-scripting-environment/src/objects/properties.ts:353

`Static`isVariableList

isVariableList(obj: any): boolean
Determines if the given object is a VariableList.
Parameters
- obj: any
  The object to check.
Returns boolean
A boolean indicating whether the object is a VariableList.
- Defined in packages/insomnia-scripting-environment/src/objects/variables.ts:135

Class VariableList<T>

Type Parameters

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Parameters

Returns VariableList<T>

Properties

Protectedlist

Protectedparent

ProtectedtypeClass

Methods

add

Parameters

Returns void

all

Returns { [k: string]: any }[]

append

Parameters

Returns void

assimilate

Parameters

Returns void

clear

Returns void

count

Returns number

each

Parameters

Returns void

eachParent

Parameters

Returns void

filter

Parameters

Returns T[]

find

Parameters

Returns undefined | T

get

Parameters

Returns undefined | T

has

Parameters

Returns boolean

idx

Parameters

Returns undefined | T

indexOf

Parameters

Returns number

insert

Parameters

Returns void

insertAfter

Parameters

Returns void

map

Parameters

Returns any[]

one

Parameters

Returns undefined | T

populate

Parameters

Returns void

prepend

Parameters

Returns void

reduce

Parameters

Returns any

remove

Parameters

Returns void

`Protected`list

`Protected`parent

`Protected`typeClass

`Static`isPropertyList

`Static`isVariableList