fast-array-of

A fast, proxy-indexed array gives you the ability to create an array that is superior in performance when working with arrays.

fast-array-of is caches and indexes the data and returns the proxied value, which provides superiority over the standard arrays in js

Provides fast

• search by key
• adding a value to an array
• change of value by key
• deletion by key
• deletion of all values of an array

Installation

$ npm i fast-array-of

Usage

arrayOf uses generic types.
The first argument is a unique key that will be used for caching and further use, if it is not defined (null) then by default indexing starting from 0 will be used

import { arrayOf, IArrayOf } from 'fast-array-of'

// primitive values
const arr: IArrayOf<number> = arrayOf<number>(null, 1, 2, 3, 4)

arr.findByKey(1) // return 2


// array of objects
interface User {
  id: number,
  age: number
  name: string
}

const arrOfObjects: IArrayOf<User> = arrayOf<User>('id', { id: 1, age: 15, name: 'first' }, { id: 2, age: 20, name: 'second' }, { id: 3, age: 43, name: 'third' })

arrOfObjects.findByKey(3) // return { id: 3, age: 43, name: 'third' }

Security

Ensure the protection of your data stored in the fast-array-of. Data protection is carried out by secure cryptographic algorithms using best practices and patterns. It is based on the SHA-256 hash function, developed by the National Security Agency (NSA). SHA-256 is one of the four variants of the SHA-2 suite and provides much better security. Also security of the fast-array-of based on the AES encryption algorithm. The Advanced Encryption Standard (AES) is the US Federal Information Processing Standard (FIPS) selected after a 5-year process that evaluated 15 competing designs.

Security usage

To use the secure fast-array-of, you need to set the value of the flag "secure" to true.

Be sure to create a SECURITY_KEY in the environment (.env)

import { arrayOf, IArrayOf } from 'fast-array-of'

// primitive values
const arr: IArrayOf<number> = arrayOf<number>({
  key: null,
  secure: true
}, 1, 2, 3, 4)

arr.findByKey(1) // return 2


// array of objects
interface User {
  id: number,
  age: number
  name: string
}

const arrOfObjects: IArrayOf<User> = arrayOf<User>({
  key: 'id',
  secure: true
}, { id: 1, age: 15, name: 'first' }, { id: 2, age: 20, name: 'second' }, { id: 3, age: 43, name: 'third' })

arrOfObjects.findByKey(3) // return { id: 3, age: 43, name: 'third' }

Methods / Properties

| Method / Property name | Description | | ------------------------------------------------| ----------- | | Properties | | | length | Returned the length of the array. | | Methods | | | findByKey() | Finds a value by key. | | set() | Modifies the value by key if such exists or adds a new value if it does not exist. | | remove() | Removes a value by key. | | clear() | Clears the entire array. | | entries() | Returns a new array that contains the [key, value] pairs for each element in the fast-array-of, in insertion order. | | values() | Returns a new array that contains the values for each element in the fast-array-of, in insertion order | | keys() | Returns a new array that contains the keys for each element in the fast-array-of, in insertion order. Always return hashed key | | Params | | | isRaw | Argument type is boolean value, it makes sense to use only with secure array, can be passed in methods entries(), values(). If the value is true, the method returns the raw data in encrypted form |

Tests result

approximate average data that varies within the specified limits when using an array with 10.000 elements

With fast-array-of

[Fast array find value]: key = 10000 (1)
  Timestamp: 0.211ms
[Fast array find value]: key = 10000 (2)
  Timestamp: 0.009ms
[Fast array set value]: key = 10000 (1)
  Timestamp: 0.048ms
[Fast array remove value]: key = 10000 (1)
  Timestamp: 0.051ms

With js array

[Array find value]: key = 10000 (1)
  Timestamp: 0.548ms
[Array find value]: key = 10000 (2)
  Timestamp: 0.329ms
[Array set value]: key = 10000 (1)
  Timestamp: 0.352ms
[Array remove value]: key = 10000 (1)
  Timestamp: 0.721ms