BinariesImpl

@webda/core

---

Class: BinariesImpl<T>

Defined in: packages/core/src/services/binary.service.ts:759

Define a collection of Binary — many-cardinality binary attribute.

Tagged as a Behavior so its @Action methods register as <Model>.<Attribute>.<Action> operations alongside Single-Binary ones. Inherits from Array<BinariesItem<T>> so it preserves array semantics (iteration, indexed access, JSON.stringify-as-array). The transformer detects this Array-subclass shape and emits a push-based hydration coercion — see behaviors.ts:createHydrationBlock.

Read Only

Webda Behavior

Webda/BinariesImpl

Extends

• Array<BinariesItem<T>>

Type Parameters

T

T extends object = { }

Indexable

[n: number]: BinariesItem<T>

Constructors

Constructor

new BinariesImpl<T>(arrayLength): BinariesImpl<T>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1515

Parameters

arrayLength

number

Returns

BinariesImpl<T>

Inherited from

Array<BinariesItem<T>>.constructor

Constructor

new BinariesImpl<T>(...items): BinariesImpl<T>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1516

Parameters

items

...BinariesItem<T>[]

Returns

BinariesImpl<T>

Inherited from

Array<BinariesItem<T>>.constructor

Properties

[unscopables]

readonly [unscopables]: object

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:97

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

Index Signature

[key: number]: boolean

[iterator]?

optional [iterator]?: boolean

[unscopables]?

readonly optional [unscopables]?: boolean

Is an object whose properties have the value 'true' when they will be absent when used in a 'with' statement.

at?

optional at?: boolean

concat?

optional concat?: boolean

copyWithin?

optional copyWithin?: boolean

entries?

optional entries?: boolean

every?

optional every?: boolean

fill?

optional fill?: boolean

filter?

optional filter?: boolean

find?

optional find?: boolean

findIndex?

optional findIndex?: boolean

flat?

optional flat?: boolean

flatMap?

optional flatMap?: boolean

forEach?

optional forEach?: boolean

includes?

optional includes?: boolean

indexOf?

optional indexOf?: boolean

join?

optional join?: boolean

keys?

optional keys?: boolean

lastIndexOf?

optional lastIndexOf?: boolean

length?

optional length?: boolean

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

map?

optional map?: boolean

pop?

optional pop?: boolean

push?

optional push?: boolean

reduce?

optional reduce?: boolean

reduceRight?

optional reduceRight?: boolean

reverse?

optional reverse?: boolean

shift?

optional shift?: boolean

slice?

optional slice?: boolean

some?

optional some?: boolean

sort?

optional sort?: boolean

splice?

optional splice?: boolean

toLocaleString?

optional toLocaleString?: boolean

toString?

optional toString?: boolean

unshift?

optional unshift?: boolean

values?

optional values?: boolean

Inherited from

Array.[unscopables]

---

[WEBDA_STORAGE]

protected [WEBDA_STORAGE]: object

Defined in: packages/core/src/services/binary.service.ts:760

Index Signature

[key: string]: any

service?

optional service?: BinaryService

---

length

length: number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1329

Gets or sets the length of the array. This is a number one higher than the highest index in the array.

Inherited from

Array.length

---

[species]

readonly static [species]: ArrayConstructor

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts:316

Inherited from

Array.[species]

Methods

[iterator]()

[iterator](): ArrayIterator<BinariesItem<T>>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:78

Iterator

Returns

ArrayIterator<BinariesItem<T>>

Inherited from

Array.[iterator]

---

assign()

assign(model, attribute): this

Defined in: packages/core/src/services/binary.service.ts:777

Bind this collection to a model and attribute, populating from existing binary data.

Legacy entry-point used by code that constructs a BinariesImpl() directly (tests, manual instantiation). The Behavior-hydration path the transformer emits writes WEBDA_STORAGE["__parent__"] instead and never calls assign.

Parameters

model

Model

the model to use

attribute

string

the attribute name

Returns

this

this for chaining

---

at()

at(index): BinariesItem<T>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2022.array.d.ts:24

Returns the item located at the specified index.

Parameters

index

number

The zero-based index of the desired code unit. A negative index will count back from the last item.

Returns

BinariesItem<T>

Inherited from

Array.at

---

attach()

attach(): Promise<void>

Defined in: packages/core/src/services/binary.service.ts:886

Direct (multipart / raw) upload from an HTTP request. Pushes a new item onto the collection.

POST /<plural>/{uuid}/<attribute> — same shape as Binary.attach but pushes the new file rather than replacing the existing one. Migrated from DomainService.binaryPut (MANY-cardinality branch).

Returns

Promise<void>

---

attachChallenge()

attachChallenge(body?): Promise<any>

Defined in: packages/core/src/services/binary.service.ts:914

Challenge-based upload handshake for the next item.

PUT /<plural>/{uuid}/<attribute> — request a pre-signed upload URL for a new item identified by { hash, challenge, ... }. Returns the URL or a done flag if dedup matched.

Migrated from DomainService.binaryChallenge (MANY-cardinality branch).

Parameters

body?

BinaryFileInfo<{ }> & object

the challenge body; falls back to context.getInput()

Returns

Promise<any>

{ url?, method?, headers?, done, md5 }

---

concat()

Call Signature

concat(...items): BinariesItem<T>[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1353

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

...ConcatArray<BinariesItem<T>>[]

Additional arrays and/or items to add to the end of the array.

Returns

BinariesItem<T>[]

Inherited from

Array.concat

Call Signature

concat(...items): BinariesItem<T>[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1359

Combines two or more arrays. This method returns a new array without modifying any existing arrays.

Parameters

items

...(BinariesItem<T> | ConcatArray<BinariesItem<T>>)[]

Additional arrays and/or items to add to the end of the array.

Returns

BinariesItem<T>[]

Inherited from

Array.concat

---

copyWithin()

copyWithin(target, start, end?): this

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:62

Returns the this object after copying a section of the array identified by start and end to the same array starting at position target

Parameters

target

number

If target is negative, it is treated as length+target where length is the length of the array.

start

number

If start is negative, it is treated as length+start. If end is negative, it is treated as length+end.

end?

number

If not specified, length of the this object is used as its default value.

Returns

this

Inherited from

Array.copyWithin

---

delete()

delete(item): Promise<void>

Defined in: packages/core/src/services/binary.service.ts:860

Delete an item by reference or index. Direct programmatic API (non-HTTP).

Parameters

item

BinariesItem<T>

the item to delete

Returns

Promise<void>

---

deleteAt()

deleteAt(index, hash): Promise<void>

Defined in: packages/core/src/services/binary.service.ts:1020

Delete a single item by (index, hash).

DELETE /<plural>/{uuid}/<attribute>/{index}/{hash} — the URL {hash} must match the item at {index}. Removes from storage and from the in-memory collection.

Migrated from DomainService.binaryAction (action="delete", MANY-cardinality branch).

Parameters

index

number

the item position

hash

string

the URL-supplied hash; must match this[index].hash

Returns

Promise<void>

---

entries()

entries(): ArrayIterator<[number, BinariesItem<T>]>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:83

Returns an iterable of key, value pairs for every entry in the array

Returns

ArrayIterator<[number, BinariesItem<T>]>

Inherited from

Array.entries

---

every()

Call Signature

every<S>(predicate, thisArg?): this is S[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1440

Determines whether all the members of an array satisfy the specified test.

Type Parameters

S

S extends BinariesItem<T>

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

this is S[]

Inherited from

Array.every

Call Signature

every(predicate, thisArg?): boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1449

Determines whether all the members of an array satisfy the specified test.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The every method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value false, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Array.every

---

fill()

fill(value, start?, end?): this

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:51

Changes all array elements from start to end index to a static value and returns the modified array

Parameters

value

BinariesItem

value to fill array section with

start?

number

index to start filling the array at. If start is negative, it is treated as length+start where length is the length of the array.

end?

number

index to stop filling the array at. If end is negative, it is treated as length+end.

Returns

this

Inherited from

Array.fill

---

filter()

Call Signature

filter<S>(predicate, thisArg?): S[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1476

Returns the elements of an array that meet the condition specified in a callback function.

Type Parameters

S

S extends BinariesItem<T>

Parameters

predicate

(value, index, array) => value is S

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

S[]

Inherited from

Array.filter

Call Signature

filter(predicate, thisArg?): BinariesItem<T>[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1482

Returns the elements of an array that meet the condition specified in a callback function.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The filter method calls the predicate function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

BinariesItem<T>[]

Inherited from

Array.filter

---

find()

Call Signature

find<S>(predicate, thisArg?): S

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:29

Returns the value of the first element in the array where predicate is true, and undefined otherwise.

Type Parameters

S

S extends BinariesItem<T>

Parameters

predicate

(value, index, obj) => value is S

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, find immediately returns that element value. Otherwise, find returns undefined.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

S

Inherited from

Array.find

Call Signature

find(predicate, thisArg?): BinariesItem<T>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:30

Parameters

predicate

(value, index, obj) => unknown

thisArg?

any

Returns

BinariesItem<T>

Inherited from

Array.find

---

findIndex()

findIndex(predicate, thisArg?): number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:41

Returns the index of the first element in the array where predicate is true, and -1 otherwise.

Parameters

predicate

(value, index, obj) => unknown

find calls predicate once for each element of the array, in ascending order, until it finds one where predicate returns true. If such an element is found, findIndex immediately returns that element index. Otherwise, findIndex returns -1.

thisArg?

any

If provided, it will be used as the this value for each invocation of predicate. If it is not provided, undefined is used instead.

Returns

number

Inherited from

Array.findIndex

---

flat()

flat<A, D>(this, depth?): FlatArray<A, D>[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.array.d.ts:75

Returns a new array with all sub-array elements concatenated into it recursively up to the specified depth.

Type Parameters

A

A

D

D extends number = 1

Parameters

this

A

depth?

D

The maximum recursion depth

Returns

FlatArray<A, D>[]

Inherited from

Array.flat

---

flatMap()

flatMap<U, This>(callback, thisArg?): U[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2019.array.d.ts:64

Calls a defined callback function on each element of an array. Then, flattens the result into a new array. This is identical to a map followed by flat with depth 1.

Type Parameters

U

U

This

This = undefined

Parameters

callback

(this, value, index, array) => U | readonly U[]

A function that accepts up to three arguments. The flatMap method calls the callback function one time for each element in the array.

thisArg?

This

An object to which the this keyword can refer in the callback function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.flatMap

---

forEach()

forEach(callbackfn, thisArg?): void

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1464

Performs the specified action for each element in an array.

Parameters

callbackfn

(value, index, array) => void

A function that accepts up to three arguments. forEach calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

void

Inherited from

Array.forEach

---

get()

get(index): Promise<void>

Defined in: packages/core/src/services/binary.service.ts:946

Stream a single item to the response, or 302-redirect to a signed URL.

GET /<plural>/{uuid}/<attribute>/{index} — locates the item by index and behaves like Binary.get for that single entry.

Migrated from DomainService.binaryGet (MANY-cardinality branch).

Parameters

index

number

the item position in the collection

Returns

Promise<void>

---

getParent()

protected getParent(): object

Defined in: packages/core/src/services/binary.service.ts:809

Read the Behavior parent reference. Mirrors Binary.getParent().

Returns

object

the parent reference or undefined

attribute

attribute: string

instance

instance: Storable

---

getService()

protected getService(): BinaryService

Defined in: packages/core/src/services/binary.service.ts:794

Resolve the BinaryService lazily via the Behavior parent reference.

Mirrors Binary.getService(). The transformer-emitted parent slot (WEBDA_STORAGE["__parent__"]) is the source of truth.

Returns

BinaryService

the BinaryService for this collection's parent attribute

---

getUrl()

getUrl(index): Promise<{ Location: string; Map: BinaryMap<T>; }>

Defined in: packages/core/src/services/binary.service.ts:983

Return a { Location, Map } JSON for a single item.

GET /<plural>/{uuid}/<attribute>/{index}/url — variant of get that returns the URL as JSON instead of redirecting / streaming.

Migrated from DomainService.binaryGet's returnUrl branch (MANY-cardinality).

Parameters

index

number

the item position in the collection

Returns

Promise<{ Location: string; Map: BinaryMap<T>; }>

{ Location, Map }

---

includes()

includes(searchElement, fromIndex?): boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2016.array.include.d.ts:25

Determines whether an array includes a certain element, returning true or false as appropriate.

Parameters

searchElement

BinariesItem

The element to search for.

fromIndex?

number

The position in this array at which to begin searching for searchElement.

Returns

boolean

Inherited from

Array.includes

---

indexOf()

indexOf(searchElement, fromIndex?): number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1425

Returns the index of the first occurrence of a value in an array, or -1 if it is not present.

Parameters

searchElement

BinariesItem

The value to locate in the array.

fromIndex?

number

The array index at which to begin the search. If fromIndex is omitted, the search starts at index 0.

Returns

number

Inherited from

Array.indexOf

---

join()

join(separator?): string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1364

Adds all the elements of an array into a string, separated by the specified separator string.

Parameters

separator?

string

A string used to separate one element of the array from the next in the resulting string. If omitted, the array elements are separated with a comma.

Returns

string

Inherited from

Array.join

---

keys()

keys(): ArrayIterator<number>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:88

Returns an iterable of keys in the array

Returns

ArrayIterator<number>

Inherited from

Array.keys

---

lastIndexOf()

lastIndexOf(searchElement, fromIndex?): number

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1431

Returns the index of the last occurrence of a specified value in an array, or -1 if it is not present.

Parameters

searchElement

BinariesItem

The value to locate in the array.

fromIndex?

number

The array index at which to begin searching backward. If fromIndex is omitted, the search starts at the last index in the array.

Returns

number

Inherited from

Array.lastIndexOf

---

map()

map<U>(callbackfn, thisArg?): U[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1470

Calls a defined callback function on each element of an array, and returns an array that contains the results.

Type Parameters

U

U

Parameters

callbackfn

(value, index, array) => U

A function that accepts up to three arguments. The map method calls the callbackfn function one time for each element in the array.

thisArg?

any

An object to which the this keyword can refer in the callbackfn function. If thisArg is omitted, undefined is used as the this value.

Returns

U[]

Inherited from

Array.map

---

pop()

pop(): BinariesItem<T>

Defined in: packages/core/src/services/binary.service.ts:814

Returns

BinariesItem<T>

Throws

Readonly collection

Overrides

Array.pop

---

push()

push(...args): number

Defined in: packages/core/src/services/binary.service.ts:834

Add binary items, wrapping plain objects in BinariesItem

Parameters

args

...any[]

additional arguments

Returns

number

the result number

Overrides

Array.push

---

reduce()

Call Signature

reduce(callbackfn): BinariesItem

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1488

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => BinariesItem

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

Returns

BinariesItem

Inherited from

Array.reduce

Call Signature

reduce(callbackfn, initialValue): BinariesItem

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1489

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => BinariesItem

initialValue

BinariesItem

Returns

BinariesItem

Inherited from

Array.reduce

Call Signature

reduce<U>(callbackfn, initialValue): U

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1495

Calls the specified callback function for all the elements in an array. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduce method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduce

---

reduceRight()

Call Signature

reduceRight(callbackfn): BinariesItem

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1501

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => BinariesItem

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

Returns

BinariesItem

Inherited from

Array.reduceRight

Call Signature

reduceRight(callbackfn, initialValue): BinariesItem

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1502

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => BinariesItem

initialValue

BinariesItem

Returns

BinariesItem

Inherited from

Array.reduceRight

Call Signature

reduceRight<U>(callbackfn, initialValue): U

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1508

Calls the specified callback function for all the elements in an array, in descending order. The return value of the callback function is the accumulated result, and is provided as an argument in the next call to the callback function.

Type Parameters

U

U

Parameters

callbackfn

(previousValue, currentValue, currentIndex, array) => U

A function that accepts up to four arguments. The reduceRight method calls the callbackfn function one time for each element in the array.

initialValue

U

If initialValue is specified, it is used as the initial value to start the accumulation. The first call to the callbackfn function provides this value as an argument instead of an array value.

Returns

U

Inherited from

Array.reduceRight

---

reverse()

reverse(): BinariesItem<T>[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1369

Reverses the elements in an array in place. This method mutates the array and returns a reference to the same array.

Returns

BinariesItem<T>[]

Inherited from

Array.reverse

---

setMetadata()

setMetadata(index, hash, metadata?): Promise<void>

Defined in: packages/core/src/services/binary.service.ts:1050

Update the metadata sidecar of a single item.

PUT /<plural>/{uuid}/<attribute>/{index}/{hash} — verifies the hash, applies the new metadata, and persists via parent.instance.patch(...). Metadata payload capped at 4 KB.

Migrated from DomainService.binaryAction (action="metadata", MANY-cardinality branch).

Parameters

index

number

the item position

hash

string

the URL-supplied hash; must match this[index].hash

metadata?

T

the new metadata blob (≤ 4 KB JSON)

Returns

Promise<void>

---

shift()

shift(): BinariesItem<T>

Defined in: packages/core/src/services/binary.service.ts:826

Returns

BinariesItem<T>

Throws

Readonly collection

Overrides

Array.shift

---

slice()

slice(): BinariesItem<T>[]

Defined in: packages/core/src/services/binary.service.ts:818

Returns

BinariesItem<T>[]

Throws

Readonly collection

Overrides

Array.slice

---

some()

some(predicate, thisArg?): boolean

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1458

Determines whether the specified callback function returns true for any element of an array.

Parameters

predicate

(value, index, array) => unknown

A function that accepts up to three arguments. The some method calls the predicate function for each element in the array until the predicate returns a value which is coercible to the Boolean value true, or until the end of the array.

thisArg?

any

An object to which the this keyword can refer in the predicate function. If thisArg is omitted, undefined is used as the this value.

Returns

boolean

Inherited from

Array.some

---

sort()

sort(compareFn?): this

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1395

Sorts an array in place. This method mutates the array and returns a reference to the same array.

Parameters

compareFn?

(a, b) => number

Function used to determine the order of the elements. It is expected to return a negative value if the first argument is less than the second argument, zero if they're equal, and a positive value otherwise. If omitted, the elements are sorted in ascending, UTF-16 code unit order.

[11,2,22,1].sort((a, b) => a - b)

Returns

this

Inherited from

Array.sort

---

splice()

Call Signature

splice(start, deleteCount?): BinariesItem<T>[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1404

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount?

number

The number of elements to remove. Omitting this argument will remove all elements from the start paramater location to end of the array. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

Returns

BinariesItem<T>[]

An array containing the elements that were deleted.

Inherited from

Array.splice

Call Signature

splice(start, deleteCount, ...items): BinariesItem<T>[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1414

Removes elements from an array and, if necessary, inserts new elements in their place, returning the deleted elements.

Parameters

start

number

The zero-based location in the array from which to start removing elements.

deleteCount

number

The number of elements to remove. If value of this argument is either a negative number, zero, undefined, or a type that cannot be converted to an integer, the function will evaluate the argument as zero and not remove any elements.

items

...BinariesItem<T>[]

Elements to insert into the array in place of the deleted elements.

Returns

BinariesItem<T>[]

An array containing the elements that were deleted.

Inherited from

Array.splice

---

toJSON()

toJSON(): BinariesItem<T>[]

Defined in: packages/core/src/services/binary.service.ts:1080

Native array serialization. The transformer adds a Behavior-style toJSON to every Behavior class unless the author defines one; we override it explicitly so JSON.stringify produces a plain array of items rather than an object keyed by indices.

Returns

BinariesItem<T>[]

the result array

---

toLocaleString()

Call Signature

toLocaleString(): string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1337

Returns a string representation of an array. The elements are converted to string using their toLocaleString methods.

Returns

string

Inherited from

Array.toLocaleString

Call Signature

toLocaleString(locales, options?): string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:64

Parameters

locales

string | string[]

options?

NumberFormatOptions & DateTimeFormatOptions

Returns

string

Inherited from

Array.toLocaleString

---

toString()

toString(): string

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1333

Returns a string representation of an array.

Returns

string

Inherited from

Array.toString

---

unshift()

unshift(): number

Defined in: packages/core/src/services/binary.service.ts:822

Returns

number

Throws

Readonly collection

Overrides

Array.unshift

---

upload()

upload(file, replace?): Promise<void>

Defined in: packages/core/src/services/binary.service.ts:843

Upload a file to this model. Direct programmatic API (non-HTTP).

Parameters

file

BinaryFile<T>

the file path

replace?

BinariesItem<T>

whether to replace existing

Returns

Promise<void>

---

values()

values(): ArrayIterator<BinariesItem<T>>

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:93

Returns an iterable of values in the array

Returns

ArrayIterator<BinariesItem<T>>

Inherited from

Array.values

---

from()

Call Signature

static from<T>(arrayLike): T[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:72

Creates an array from an array-like object.

Type Parameters

T

T

Parameters

arrayLike

ArrayLike<T>

An array-like object to convert to an array.

Returns

T[]

Inherited from

Array.from

Call Signature

static from<T, U>(arrayLike, mapfn, thisArg?): U[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:80

Creates an array from an iterable object.

Type Parameters

T

T

U

U

Parameters

arrayLike

ArrayLike<T>

An array-like object to convert to an array.

mapfn

(v, k) => U

A mapping function to call on every element of the array.

thisArg?

any

Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

Array.from

Call Signature

static from<T>(iterable): T[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:101

Creates an array from an iterable object.

Type Parameters

T

T

Parameters

iterable

Iterable<T, any, any> | ArrayLike<T>

An iterable object to convert to an array.

Returns

T[]

Inherited from

Array.from

Call Signature

static from<T, U>(iterable, mapfn, thisArg?): U[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.iterable.d.ts:109

Creates an array from an iterable object.

Type Parameters

T

T

U

U

Parameters

iterable

Iterable<T, any, any> | ArrayLike<T>

An iterable object to convert to an array.

mapfn

(v, k) => U

A mapping function to call on every element of the array.

thisArg?

any

Value of 'this' used to invoke the mapfn.

Returns

U[]

Inherited from

Array.from

---

isArray()

static isArray(arg): arg is any[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es5.d.ts:1520

Parameters

arg

any

Returns

arg is any[]

Inherited from

Array.isArray

---

of()

static of<T>(...items): T[]

Defined in: node_modules/.pnpm/typescript@5.9.3/node_modules/typescript/lib/lib.es2015.core.d.ts:86

Returns a new array from a set of elements.

Type Parameters

T

T

Parameters

items

...T[]

A set of elements to include in the new array object.

Returns

T[]

Inherited from

Array.of