Skip to content
This repository was archived by the owner on Jan 2, 2024. It is now read-only.

Commit f5c6ba3

Browse files
committed
First cut of README
1 parent 5654f03 commit f5c6ba3

File tree

2 files changed

+43
-1
lines changed

2 files changed

+43
-1
lines changed

README.md

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
Sorted Array
2+
======
3+
4+
An array that keeps its elements sorted with advanced comparison capabilities and a built-in support for an array of objects.
5+
6+
## Installation
7+
8+
```
9+
npm install @gurisko/sorted-array
10+
```
11+
12+
## API
13+
14+
#### `new SortedArray()`
15+
16+
#### `new SortedArray([key], [compare])`
17+
18+
#### `arr.insert([element1[, ...[, elementN]]])`
19+
20+
#### `arr.get(index)`
21+
22+
#### `arr.has(value)`
23+
24+
#### `arr.search(value)`
25+
26+
#### `arr.remove(index)`
27+
28+
#### `arr.removeByValue(value)`
29+
30+
#### `arr.eq(value)`
31+
32+
#### `arr.gt(value)`
33+
34+
#### `arr.gte(value)`
35+
36+
#### `arr.lt(value)`
37+
38+
#### `arr.lte(value)`
39+
40+
#### `arr.toArray()`
41+
42+
#### `arr.clear()`

package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@gurisko/sorted-array",
3-
"version": "0.1.0",
3+
"version": "0.1.2",
44
"description": "",
55
"repository": "https://github.com/gurisko/sorted-array",
66
"main": "./lib/index.js",

0 commit comments

Comments
 (0)