Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DatabaseArray

A DatabaseArray is the database-representation of an array.

author

Nicolas Schmidt <@nsc-de>

see

DatabaseArray.data - the data of the array

see

DatabaseArray.length - the array length

see

DatabaseArray.constructor() - the constructor

see

DatabaseArray.set() - sets a value from the DatabaseArray

see

DatabaseArray.setDefault() - sets a default value from the DatabaseArray

see

DatabaseArray.get() - gets a value from the DatabaseArray

see

DatabaseArray.getNormal() - gets a value from the DatabaseArray and normalizes it

see

DatabaseArray.update() - updates a value from the DatabaseArray

see

DatabaseArray.contains() - checks if the DatabaseArray contains a value

see

DatabaseArray.push() - push a value into the DatabaseArray

Hierarchy

  • DatabaseArray

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

_data

Accessors

data

length

  • get length(): number

Methods

contains

  • contains(key: number | string | Array<string | number>): boolean
  • Checks if the DatabaseArray contains a value

    author

    Nicolas Schmidt <@nsc-de>

    see

    DatabaseArray - 👩‍👦 the parent class

    Parameters

    • key: number | string | Array<string | number>

      the path to check

    Returns boolean

    does the array contains the value

get

  • get(key: number | string | Array<string | number>): DatabaseValue

getNormal

push

set

  • Sets a value from the DatabaseArray.

    author

    Nicolas Schmidt <@nsc-de>

    see

    DatabaseArray - 👩‍👦 the parent class

    Parameters

    • key: number | string | Array<string | number>

      the path to apply the value to

    • value: DatabaseInsertable

      the value to apply to the given path

    Returns this

    the DatabaseArray itself, so you can chain operations like that

setDefault

  • setDefault(key: number | string | Array<string | number>, value: DatabaseInsertable): this

update

Generated using TypeDoc