Array

Array Utilities.

type ArrayOf1<T = Primitive> = Array<T>

type ArrayOf2<T = Primitive, S = Primitive> = Array<(T|S)>

type ArrayOf3<T = Primitive, S = Primitive, U = PrimitiveOrUndefined> = Array<(T|S|U)>

type IfArray<ARGS, T> = ARGS extends Array<Any> ? Array<T> : T

type JsonArray = Strings | Numbers | UnknownRecords

type OrArray<T> = T | Array<T>

function apiSort(
  request: ApiFindRequest
): number

function apiSortUpdatedDecending(
  a: StoredMedia, 
  b: StoredMedia
): number

function apiSorter(
  string: string, 
  allowTrailing?: boolean
): string

function arrayFromOneOrMore<T = unknown>(
  value?: T | Array<T>
): Array<T>

function arrayLast<T = Primitive>(
  array: Array<T>
): T

function arrayOfNumbers(
  count?: number, 
  start?: number
): Numbers

function arrayOrFirst<T = object | string, ARGS = OrArray<unknown>>(
  args: ARGS, 
  data: Array<T>
): IfArray<ARGS, T>

function arrayRemove<T = Primitive>(
  array: Array<T>, 
  item: T | Array<T>
): boolean

/**
 * Replaces the contents of an array with
 * the contents of another array.
 */
function arraySet<T = Primitive>(
  array: Array<T>, 
  items: Array<T>
): Array<T>

function arrayUnique<T = Primitive>(
  array: Array<T>
): Array<T>

function arrayUnzip<T = unknown>(
  array: Array<T>, 
  func: BooleanFunction
): Tuples<T>

function arraysEqual<T = unknown>(
  first: Array<T>, 
  second: Array<T>
): boolean

function sortByFrame(
  a: WithFrame, 
  b: WithFrame
): number

function sortByIndex(
  a: WithIndex, 
  b: WithIndex
): number

function sortByOrder(
  a: WithOrder, 
  b: WithOrder
): number

function sortByType(
  a: WithType, 
  b: WithType
): number