collectype

collectype v0.11.0

---

collectype / FullFunctions / FullFunctions

Class: FullFunctions<T>

Defined in: FullFunctions.ts:117

Core collection manipulation class providing chainable operations. Serves as the foundation for filtering, sorting, and transforming collections of any type.

Extends

• BaseFunctions<T>

Type Parameters

T

T

The type of items in the collection.

Constructors

Constructor

new FullFunctions<T>(items): FullFunctions<T>

Defined in: BaseFunctions.ts:33

Creates an instance of BaseFunctions.

Parameters

items

T[]

Array of items to operate on.

Returns

FullFunctions<T>

Inherited from

BaseFunctions.constructor

Properties

_items

protected _items: T[]

Defined in: BaseFunctions.ts:24

Inherited from

BaseFunctions._items

---

_pageState?

protected optional _pageState: PageState

Defined in: BaseFunctions.ts:25

Inherited from

BaseFunctions._pageState

---

_sortState?

protected optional _sortState: SortState

Defined in: BaseFunctions.ts:26

Inherited from

BaseFunctions._sortState

---

_stepManager

protected _stepManager: StepManager

Defined in: BaseFunctions.ts:27

Inherited from

BaseFunctions._stepManager

---

arrayEquals()

arrayEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:123

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arrayNotEquals()

arrayNotEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:124

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arraySameMembers()

arraySameMembers: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:125

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arraySetEquals()

arraySetEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:126

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arraySetNotEquals()

arraySetNotEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:127

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arrayAtIndexEquals()

arrayAtIndexEquals: <K>(field, index, target) => FullFunctions

Defined in: FullFunctions.ts:130

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

index

number

target

unknown

Returns

FullFunctions

---

arrayAtIndexGreaterThan()

arrayAtIndexGreaterThan: <K>(field, index, target) => FullFunctions

Defined in: FullFunctions.ts:131

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

index

number

target

unknown

Returns

FullFunctions

---

arrayAtIndexGreaterThanOrEquals()

arrayAtIndexGreaterThanOrEquals: <K>(field, index, target) => FullFunctions

Defined in: FullFunctions.ts:132

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

index

number

target

unknown

Returns

FullFunctions

---

arrayAtIndexLessThan()

arrayAtIndexLessThan: <K>(field, index, target) => FullFunctions

Defined in: FullFunctions.ts:136

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

index

number

target

unknown

Returns

FullFunctions

---

arrayAtIndexLessThanOrEquals()

arrayAtIndexLessThanOrEquals: <K>(field, index, target) => FullFunctions

Defined in: FullFunctions.ts:137

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

index

number

target

unknown

Returns

FullFunctions

---

arrayAtIndexNotEquals()

arrayAtIndexNotEquals: <K>(field, index, target) => FullFunctions

Defined in: FullFunctions.ts:141

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

index

number

target

unknown

Returns

FullFunctions

---

arrayAtIndexIn()

arrayAtIndexIn: <K>(field, index, target) => FullFunctions

Defined in: FullFunctions.ts:144

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

index

number

target

unknown[]

Returns

FullFunctions

---

arrayAtIndexNotIn()

arrayAtIndexNotIn: <K>(field, index, target) => FullFunctions

Defined in: FullFunctions.ts:145

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

index

number

target

unknown[]

Returns

FullFunctions

---

arrayDisjoint()

arrayDisjoint: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:148

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arrayIntersects()

arrayIntersects: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:149

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arrayEveryEquals()

arrayEveryEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:152

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

arrayExcludes()

arrayExcludes: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:153

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

arrayIncludes()

arrayIncludes: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:154

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

arraySomeEquals()

arraySomeEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:155

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

arrayStrictSubsetOf()

arrayStrictSubsetOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:158

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arrayStrictSupersetOf()

arrayStrictSupersetOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:159

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arraySubsetOf()

arraySubsetOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:160

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arraySupersetOf()

arraySupersetOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:161

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arrayContainsSubsequence()

arrayContainsSubsequence: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:164

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arrayStartsWith()

arrayStartsWith: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:165

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arrayEndsWith()

arrayEndsWith: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:166

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

arraySizeEquals()

arraySizeEquals: <K>(field, size) => FullFunctions

Defined in: FullFunctions.ts:169

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

size

number

Returns

FullFunctions

---

arraySizeGreaterThan()

arraySizeGreaterThan: <K>(field, size) => FullFunctions

Defined in: FullFunctions.ts:170

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

size

number

Returns

FullFunctions

---

arraySizeGreaterThanOrEquals()

arraySizeGreaterThanOrEquals: <K>(field, size) => FullFunctions

Defined in: FullFunctions.ts:171

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

size

number

Returns

FullFunctions

---

arraySizeLessThan()

arraySizeLessThan: <K>(field, size) => FullFunctions

Defined in: FullFunctions.ts:172

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

size

number

Returns

FullFunctions

---

arraySizeLessThanOrEquals()

arraySizeLessThanOrEquals: <K>(field, size) => FullFunctions

Defined in: FullFunctions.ts:173

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

size

number

Returns

FullFunctions

---

arrayIsEmpty()

arrayIsEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:176

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

arrayIsNotEmpty()

arrayIsNotEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:177

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

bigintEquals()

bigintEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:184

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

bigint

Returns

FullFunctions

---

bigintGreaterThan()

bigintGreaterThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:185

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

bigint

Returns

FullFunctions

---

bigintGreaterThanOrEquals()

bigintGreaterThanOrEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:186

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

bigint

Returns

FullFunctions

---

bigintLessThan()

bigintLessThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:187

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

bigint

Returns

FullFunctions

---

bigintLessThanOrEquals()

bigintLessThanOrEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:188

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

bigint

Returns

FullFunctions

---

bigintNotEquals()

bigintNotEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:189

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

bigint

Returns

FullFunctions

---

bigintNotIn()

bigintNotIn: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:192

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

bigint[]

Returns

FullFunctions

---

bigintIn()

bigintIn: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:193

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

bigint[]

Returns

FullFunctions

---

bigintBetween()

bigintBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:196

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

bigint

max

bigint

Returns

FullFunctions

---

bigintNotBetween()

bigintNotBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:197

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

bigint

max

bigint

Returns

FullFunctions

---

bigintStrictBetween()

bigintStrictBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:198

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

bigint

max

bigint

Returns

FullFunctions

---

bigintStrictNotBetween()

bigintStrictNotBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:199

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

bigint

max

bigint

Returns

FullFunctions

---

bigintIsEven()

bigintIsEven: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:202

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

bigintIsNegative()

bigintIsNegative: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:203

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

bigintIsOdd()

bigintIsOdd: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:204

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

bigintIsPositive()

bigintIsPositive: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:205

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

bigintIsZero()

bigintIsZero: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:206

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

booleanEquals()

booleanEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:213

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

boolean

Returns

FullFunctions

---

booleanNotEquals()

booleanNotEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:214

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

boolean

Returns

FullFunctions

---

booleanIsFalse()

booleanIsFalse: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:217

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

booleanIsTrue()

booleanIsTrue: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:218

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsFirstDayOfMonth()

dateIsFirstDayOfMonth: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:225

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsFuture()

dateIsFuture: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:226

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsLastDayOfMonth()

dateIsLastDayOfMonth: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:227

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsPast()

dateIsPast: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:228

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsToday()

dateIsToday: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:229

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsTomorrow()

dateIsTomorrow: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:230

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsWeekday()

dateIsWeekday: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:231

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsWeekend()

dateIsWeekend: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:232

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsYesterday()

dateIsYesterday: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:233

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateAfter()

dateAfter: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:236

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateAfterOrEqual()

dateAfterOrEqual: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:237

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateBefore()

dateBefore: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:238

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateBeforeOrEqual()

dateBeforeOrEqual: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:239

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateEquals()

dateEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:240

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateNotEquals()

dateNotEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:241

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateSameDay()

dateSameDay: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:242

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateSameMonth()

dateSameMonth: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:243

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateSameYear()

dateSameYear: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:244

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Date

Returns

FullFunctions

---

dateBetween()

dateBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:247

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

Date

max

Date

Returns

FullFunctions

---

dateNotBetween()

dateNotBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:248

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

Date

max

Date

Returns

FullFunctions

---

dateStrictBetween()

dateStrictBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:249

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

Date

max

Date

Returns

FullFunctions

---

dateStrictNotBetween()

dateStrictNotBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:250

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

Date

max

Date

Returns

FullFunctions

---

dateIsInvalid()

dateIsInvalid: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:253

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

dateIsValid()

dateIsValid: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:254

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

mapHasEntry()

mapHasEntry: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:261

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

[unknown, unknown]

Returns

FullFunctions

---

mapLacksEntry()

mapLacksEntry: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:262

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

[unknown, unknown]

Returns

FullFunctions

---

mapHasKey()

mapHasKey: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:265

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

mapLacksKey()

mapLacksKey: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:266

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

mapSizeEquals()

mapSizeEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:269

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

mapSizeGreaterThan()

mapSizeGreaterThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:270

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

mapSizeGreaterThanOrEquals()

mapSizeGreaterThanOrEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:271

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

mapSizeLessThan()

mapSizeLessThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:272

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

mapSizeLessThanOrEquals()

mapSizeLessThanOrEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:273

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

mapIsEmpty()

mapIsEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:276

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

mapIsNotEmpty()

mapIsNotEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:277

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

mapContainsValue()

mapContainsValue: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:280

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

mapLacksValue()

mapLacksValue: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:281

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

numberEquals()

numberEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:288

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

numberGreaterOrEqual()

numberGreaterOrEqual: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:289

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

numberGreaterThan()

numberGreaterThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:290

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

numberLessOrEqual()

numberLessOrEqual: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:291

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

numberLessThan()

numberLessThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:292

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

numberNotEquals()

numberNotEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:293

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

numberBetween()

numberBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:296

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

number

max

number

Returns

FullFunctions

---

numberNotBetween()

numberNotBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:297

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

number

max

number

Returns

FullFunctions

---

numberStrictBetween()

numberStrictBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:298

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

number

max

number

Returns

FullFunctions

---

numberStrictNotBetween()

numberStrictNotBetween: <K>(field, min, max) => FullFunctions

Defined in: FullFunctions.ts:299

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

min

number

max

number

Returns

FullFunctions

---

numberIsFinite()

numberIsFinite: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:302

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

numberIsFloat()

numberIsFloat: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:303

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

numberIsInteger()

numberIsInteger: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:304

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

numberIsNegative()

numberIsNegative: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:305

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

numberIsPositive()

numberIsPositive: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:306

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

numberIsZero()

numberIsZero: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:307

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsAccessor()

objectIsAccessor: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:314

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

symbol

Returns

FullFunctions

---

objectIsConfigurable()

objectIsConfigurable: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:315

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

symbol

Returns

FullFunctions

---

objectIsDataProperty()

objectIsDataProperty: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:316

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

symbol

Returns

FullFunctions

---

objectIsEnumerable()

objectIsEnumerable: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:317

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

symbol

Returns

FullFunctions

---

objectIsWritable()

objectIsWritable: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:318

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

symbol

Returns

FullFunctions

---

objectInstanceOf()

objectInstanceOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:321

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

any

Returns

FullFunctions

---

objectIsPrototypeOf()

objectIsPrototypeOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:322

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

any

Returns

FullFunctions

---

objectIsInstanceOfClass()

objectIsInstanceOfClass: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:325

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsInstanceOfConstructor()

objectIsInstanceOfConstructor: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:326

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsInstanceOfFunction()

objectIsInstanceOfFunction: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:330

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsInstanceOfObject()

objectIsInstanceOfObject: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:331

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectContainsKey()

objectContainsKey: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:334

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

symbol

Returns

FullFunctions

---

objectLacksKey()

objectLacksKey: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:335

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

symbol

Returns

FullFunctions

---

objectIn()

objectIn: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:338

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

(string | symbol)[]

Returns

FullFunctions

---

objectNotIn()

objectNotIn: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:339

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

(string | symbol)[]

Returns

FullFunctions

---

objectContainsAllKeys()

objectContainsAllKeys: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:342

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

string[]

symbol[]

Returns

FullFunctions

---

objectContainsAnyKey()

objectContainsAnyKey: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:343

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

string[]

symbol[]

Returns

FullFunctions

---

objectContainsOnlyKeys()

objectContainsOnlyKeys: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:344

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

string[]

symbol[]

Returns

FullFunctions

---

objectContainsSymbolKeys()

objectContainsSymbolKeys: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:345

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

string[]

symbol[]

Returns

FullFunctions

---

objectEqualsKeys()

objectEqualsKeys: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:346

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

string[]

symbol[]

Returns

FullFunctions

---

objectLacksAllKeys()

objectLacksAllKeys: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:347

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

string[]

symbol[]

Returns

FullFunctions

---

objectOnlyKeys()

objectOnlyKeys: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:348

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

string[]

symbol[]

Returns

FullFunctions

---

objectStrictEqualsKeys()

objectStrictEqualsKeys: <K>(field, keys) => FullFunctions

Defined in: FullFunctions.ts:349

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

keys

string[]

symbol[]

Returns

FullFunctions

---

objectHasCamelcaseKeys()

objectHasCamelcaseKeys: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:352

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectHasHomogeneousKeys()

objectHasHomogeneousKeys: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:353

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectHasOnlyStringKeys()

objectHasOnlyStringKeys: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:354

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectHasOnlySymbolKeys()

objectHasOnlySymbolKeys: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:355

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectContainsOwnProperty()

objectContainsOwnProperty: <K>(field, key) => FullFunctions

Defined in: FullFunctions.ts:358

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

key

string

symbol

Returns

FullFunctions

---

objectContainsProperty()

objectContainsProperty: <K>(field, key) => FullFunctions

Defined in: FullFunctions.ts:359

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

key

string

symbol

Returns

FullFunctions

---

objectPrototypeContainsPrototype()

objectPrototypeContainsPrototype: <K>(field, proto) => FullFunctions

Defined in: FullFunctions.ts:362

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

proto

any

Returns

FullFunctions

---

objectPrototypeIsPrototypeOf()

objectPrototypeIsPrototypeOf: <K>(field, proto) => FullFunctions

Defined in: FullFunctions.ts:366

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

proto

any

Returns

FullFunctions

---

objectPrototypeIsNull()

objectPrototypeIsNull: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:372

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsEmpty()

objectIsEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:375

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsPlain()

objectIsPlain: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:376

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectHasNumericKeys()

objectHasNumericKeys: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:377

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectHasNestedObject()

objectHasNestedObject: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:379

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsFrozen()

objectIsFrozen: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:380

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsSealed()

objectIsSealed: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:381

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsExtensible()

objectIsExtensible: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:382

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsIterable()

objectIsIterable: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:383

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectHasNullProto()

objectHasNullProto: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:384

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectInheritsObject()

objectInheritsObject: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:385

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectIsHomogeneous()

objectIsHomogeneous: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:386

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectHasArrayProp()

objectHasArrayProp: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:387

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

objectHasNoUndefined()

objectHasNoUndefined: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:388

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

setContainsAll()

setContainsAll: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:395

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

setContainsAny()

setContainsAny: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:396

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

setExcludesAll()

setExcludesAll: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:397

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown[]

Returns

FullFunctions

---

setEquals()

setEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:400

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setNotEquals()

setNotEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:401

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setSameElements()

setSameElements: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:402

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setDisjoint()

setDisjoint: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:405

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setIntersects()

setIntersects: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:406

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setIncludes()

setIncludes: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:409

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

setExcludes()

setExcludes: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:410

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

unknown

Returns

FullFunctions

---

setStrictSubsetOf()

setStrictSubsetOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:413

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setStrictSupersetOf()

setStrictSupersetOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:414

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setSubsetOf()

setSubsetOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:415

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setSupersetOf()

setSupersetOf: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:416

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

Set<unknown>

Returns

FullFunctions

---

setSizeEquals()

setSizeEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:419

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

setSizeGreaterThan()

setSizeGreaterThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:420

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

setSizeGreaterThanOrEquals()

setSizeGreaterThanOrEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:421

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

setSizeLessThan()

setSizeLessThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:422

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

setSizeLessThanOrEquals()

setSizeLessThanOrEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:423

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

setIsEmpty()

setIsEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:426

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

setIsNotEmpty()

setIsNotEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:427

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

setHasPrimitives()

setHasPrimitives: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:428

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

setHasObjects()

setHasObjects: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:429

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

stringEquals()

stringEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:439

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

Returns

FullFunctions

---

stringGreaterThan()

stringGreaterThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:440

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

Returns

FullFunctions

---

stringLessThan()

stringLessThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:441

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

Returns

FullFunctions

---

stringNotEquals()

stringNotEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:442

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

Returns

FullFunctions

---

stringIn()

stringIn: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:445

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string[]

Returns

FullFunctions

---

stringNotIn()

stringNotIn: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:446

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string[]

Returns

FullFunctions

---

stringMatches()

stringMatches: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:449

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

RegExp

Returns

FullFunctions

---

stringNotMatches()

stringNotMatches: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:450

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

RegExp

Returns

FullFunctions

---

stringSizeEquals()

stringSizeEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:453

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

stringSizeGreaterThan()

stringSizeGreaterThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:454

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

stringSizeGreaterThanOrEquals()

stringSizeGreaterThanOrEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:455

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

stringSizeLessThan()

stringSizeLessThan: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:456

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

stringSizeLessThanOrEquals()

stringSizeLessThanOrEquals: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:457

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

number

Returns

FullFunctions

---

stringIsBlank()

stringIsBlank: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:460

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

stringIsEmpty()

stringIsEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:461

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

stringIsNotBlank()

stringIsNotBlank: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:462

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

stringIsNotEmpty()

stringIsNotEmpty: <K>(field) => FullFunctions

Defined in: FullFunctions.ts:463

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

Returns

FullFunctions

---

stringEndsWith()

stringEndsWith: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:466

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

Returns

FullFunctions

---

stringExcludes()

stringExcludes: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:467

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

Returns

FullFunctions

---

stringIncludes()

stringIncludes: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:468

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

Returns

FullFunctions

---

stringStartsWith()

stringStartsWith: <K>(field, target) => FullFunctions

Defined in: FullFunctions.ts:469

Type Parameters

K

K extends string | number | symbol

Parameters

field

K

target

string

Returns

FullFunctions

Accessors

items

Get Signature

get items(): T[]

Defined in: BaseFunctions.ts:41

Gets the array of items.

Returns

T[]

The current array of items.

Inherited from

BaseFunctions.items

---

count

Get Signature

get count(): number

Defined in: BaseFunctions.ts:49

Gets the number of items.

Returns

number

The count of items.

Inherited from

BaseFunctions.count

---

info

Get Signature

get info(): CollectionInfo

Defined in: BaseFunctions.ts:57

Gets information about the current state of the collection.

Returns

CollectionInfo

Information about pagination, sorting, filters, and operations.

Inherited from

BaseFunctions.info

Methods

begin()

begin(name): this

Defined in: BaseFunctions.ts:70

Starts a named step with stack management for nested calls. Automatically handles nested step calls without breaking the chain.

Parameters

name

string

Returns

this

Inherited from

BaseFunctions.begin

---

end()

end(): this

Defined in: BaseFunctions.ts:82

Ends the current step and pops from stack.

Returns

this

Inherited from

BaseFunctions.end

---

where()

where(fn): this

Defined in: BaseFunctions.ts:97

Filters items using the provided predicate function. This is the preferred, concise method for filtering collections.

Parameters

fn

PredicateFn<T>

The predicate function to filter items.

Returns

this

The instance for chaining.

Example

collection.fn.where(p => p.is_legendary)

Inherited from

BaseFunctions.where

---

all()

all(): this

Defined in: BaseFunctions.ts:110

Returns the current instance (all items).

Returns

this

The instance for chaining.

Inherited from

BaseFunctions.all

---

sort()

sort<K>(field, dir?, type?): this

Defined in: BaseFunctions.ts:124

Sorts the items by a specified field with automatic type detection. Automatically infers the sort type from the field value if not explicitly provided.

Type Parameters

K

K extends string | number | symbol

The key of the field to sort by.

Parameters

field

K

The field name to sort on.

dir?

SortDir = SortDirEnum.ASC

Sort direction (‘asc’ or ‘desc’). Default is ‘asc’.

type?

SortType

Sort type (‘string’, ‘number’, ‘boolean’, ‘date’). Auto-detected if omitted.

Returns

this

The instance for chaining.

Throws

Error if an unsupported sort type is provided.

Inherited from

BaseFunctions.sort

---

page()

page(current, perPage?): this

Defined in: BaseFunctions.ts:171

Paginates the items by returning a specific page of results.

Parameters

current

number

The current page number (1-based).

perPage?

number = 20

The number of items per page. Default is 20.

Returns

this

The instance for chaining.

Throws

Error if current is less than 1 or perPage is less than 1.

Inherited from

BaseFunctions.page

---

pipe()

pipe(expression): this

Defined in: BaseFunctions.ts:211

Executes a sequence of chainable operations from a pipe expression string. Parses and executes multiple method calls in sequence, ensuring each returns ‘this’ for chaining.

Parameters

expression

string

The pipe expression string (e.g., “method1(arg)

method2(arg)”).

Returns

this

The instance for chaining.

Throws

Error if a reserved method is used, unknown method is called, or method breaks the chain.

Inherited from

BaseFunctions.pipe

This site is open source. Improve this page.