diff --git a/CHANGELOG.md b/CHANGELOG.md index 615f6e0..b502abc 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,15 @@ # CHANGELOG +## v2.0.0 + +### FEATURES + +- Add _Typedoc_ and generate API documentation + +### PATCHES + +- Upgrade [_Red_](https://github.com/albert-team/red) dependency to fix compatibility issue with Node < v9.11.0 + ## v2.0.0-canary.0 ### FEATURES diff --git a/README.md b/README.md index 200c0a6..7a2235b 100644 --- a/README.md +++ b/README.md @@ -18,13 +18,13 @@ #### With `npm` ```bash -npm i @albert-team/rebloom@canary +npm i @albert-team/rebloom ``` #### With `yarn` ```bash -yarn add @albert-team/rebloom@canary +yarn add @albert-team/rebloom ``` ## Usage @@ -53,6 +53,10 @@ const main = async () => { main() ``` +### API + +Read more [here](https://albert-team.github.io/rebloom). + ## Changelog Read more [here](https://github.com/albert-team/rebloom/blob/master/CHANGELOG.md). diff --git a/docs/classes/basefilter.html b/docs/classes/basefilter.html index 0f12c73..ab77b14 100644 --- a/docs/classes/basefilter.html +++ b/docs/classes/basefilter.html @@ -132,7 +132,7 @@

constructor

  • @@ -169,7 +169,7 @@

    Protected client

    client: Red
    @@ -179,7 +179,7 @@

    Protected name

    name: string
    @@ -189,7 +189,7 @@

    Protected options

    options: Options
    @@ -206,7 +206,7 @@

    connect

  • @@ -228,7 +228,7 @@

    disconnect

  • @@ -250,7 +250,7 @@

    reset

  • diff --git a/docs/classes/bloomfilter.html b/docs/classes/bloomfilter.html index 32f960d..b707079 100644 --- a/docs/classes/bloomfilter.html +++ b/docs/classes/bloomfilter.html @@ -127,7 +127,7 @@

    constructor

    @@ -165,7 +165,7 @@

    Protected client

    @@ -176,7 +176,7 @@

    Protected name

    @@ -187,7 +187,7 @@

    Protected options

    @@ -204,7 +204,7 @@

    add

  • @@ -237,7 +237,7 @@

    connect

    @@ -260,7 +260,7 @@

    disconnect

    @@ -282,7 +282,7 @@

    exists

  • @@ -314,7 +314,7 @@

    reserve

  • @@ -353,7 +353,7 @@

    reset

    diff --git a/docs/classes/countminsketch.html b/docs/classes/countminsketch.html index 435f70e..97cbd83 100644 --- a/docs/classes/countminsketch.html +++ b/docs/classes/countminsketch.html @@ -128,7 +128,7 @@

    constructor

    @@ -166,7 +166,7 @@

    Protected client

    @@ -177,7 +177,7 @@

    Protected name

    @@ -188,7 +188,7 @@

    Protected options

    @@ -205,7 +205,7 @@

    add

  • @@ -244,7 +244,7 @@

    connect

    @@ -266,7 +266,7 @@

    count

  • @@ -300,7 +300,7 @@

    disconnect

    @@ -322,7 +322,7 @@

    fromDimensions

  • @@ -360,7 +360,7 @@

    fromProbability

  • @@ -399,7 +399,7 @@

    reset

    diff --git a/docs/classes/cuckoofilter.html b/docs/classes/cuckoofilter.html index 6d29f2e..fc3744b 100644 --- a/docs/classes/cuckoofilter.html +++ b/docs/classes/cuckoofilter.html @@ -129,7 +129,7 @@

    constructor

    @@ -167,7 +167,7 @@

    Protected client

    @@ -178,7 +178,7 @@

    Protected name

    @@ -189,7 +189,7 @@

    Protected options

    @@ -206,7 +206,7 @@

    add

  • @@ -245,7 +245,7 @@

    connect

    @@ -267,7 +267,7 @@

    count

  • @@ -301,7 +301,7 @@

    disconnect

    @@ -323,7 +323,7 @@

    exists

  • @@ -355,7 +355,7 @@

    remove

  • @@ -388,7 +388,7 @@

    reserve

  • @@ -421,7 +421,7 @@

    reset

    diff --git a/docs/classes/options.html b/docs/classes/options.html index fd3d62a..f9fc8f5 100644 --- a/docs/classes/options.html +++ b/docs/classes/options.html @@ -117,7 +117,7 @@

    constructor

  • Parameters

    @@ -140,7 +140,7 @@

    client

    @@ -157,7 +157,7 @@

    host

    @@ -168,7 +168,7 @@

    port

    @@ -179,7 +179,7 @@

    redisClientOptions

    diff --git a/docs/classes/topkfilter.html b/docs/classes/topkfilter.html index ec563ad..c6e78a8 100644 --- a/docs/classes/topkfilter.html +++ b/docs/classes/topkfilter.html @@ -128,7 +128,7 @@

    constructor

    @@ -166,7 +166,7 @@

    Protected client

    @@ -177,7 +177,7 @@

    Protected name

    @@ -188,7 +188,7 @@

    Protected options

    @@ -205,7 +205,7 @@

    add

  • @@ -244,7 +244,7 @@

    connect

    @@ -266,7 +266,7 @@

    count

  • @@ -300,7 +300,7 @@

    disconnect

    @@ -322,7 +322,7 @@

    exists

  • @@ -354,7 +354,7 @@

    reserve

  • @@ -405,7 +405,7 @@

    reset

    diff --git a/docs/index.html b/docs/index.html index d412c56..4da03d6 100644 --- a/docs/index.html +++ b/docs/index.html @@ -85,11 +85,11 @@

    Instructions

    With npm

    -
    npm i @albert-team/rebloom@canary
    +
    npm i @albert-team/rebloom

    With yarn

    -
    yarn add @albert-team/rebloom@canary
    +
    yarn add @albert-team/rebloom

    Usage

    @@ -115,6 +115,10 @@

    Get Started

    } main() + +

    API

    +
    +

    Read more here.

    Changelog

    diff --git a/docs/interfaces/optionsinterface.html b/docs/interfaces/optionsinterface.html index af1ab0b..0ca58a1 100644 --- a/docs/interfaces/optionsinterface.html +++ b/docs/interfaces/optionsinterface.html @@ -107,7 +107,7 @@

    Optional client

    client: Red
    @@ -117,7 +117,7 @@

    Optional host

    host: string
    @@ -127,7 +127,7 @@

    Optional port

    port: number
    @@ -137,7 +137,7 @@

    Optional redisClient
    redisClientOptions: object
    diff --git a/package.json b/package.json index 9c4bec1..0f7d99e 100644 --- a/package.json +++ b/package.json @@ -2,7 +2,7 @@ "name": "@albert-team/rebloom", "description": "Minimalistic RedisBloom client for Node.js", "license": "MIT", - "version": "2.0.0-canary.0", + "version": "2.0.0", "author": "Albert Team", "repository": "github:albert-team/rebloom", "main": "dist/index.js",