Giter Site home page Giter Site logo

bplus-index's Introduction

bplus-index

npm version license build

A JavaScript implementation of a B+tree structure.

A B+tree is very useful for fast lookups, ranges and sorting.

NPM

js-standard-style

API

inject(key, value)

Adds a new value to the index at the given key.

Argument Type Description
Key String or Number The key that the value will be indexed by
Value String or Number The value stored at the given key

eject(key[, value])

Removes a value from the index at the given key. If value is undefined, eject removes all values at the given key.

Argument Type Description
Key String or Number The key where the value is stored
Value String or Number The value to be removed

get(key)

Retrieves all values stored at given key

Argument Type Description
Key String or Number The key to search for

getAll([options])

Gets all values from the index sorted by key.

Argument Type Description
options object see below
options
name Type Description Default
sortDescending Boolean Sort values by key in descending order False

getRange(lowerBound, upperBound[, options])

getRange will return all values where that value's key is in the specified range

Argument Type Description
lowerBound String or Number The lower boundary of the range
upperBound String or Number The upper boundary of the range
options object see below
options
name Type Description Default
lowerInclusive Boolean Include values where the key equals lowerBound True
upperInclusive Boolean Include values where the key equals upperBound False
sortDescending Boolean Sort values by key in descending order False

Running mocha tests

npm test

Running performance tests

npm install -g babel

babel-node benchmark.js

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.