# reador-client

> Reador.net Node.js client

Latest version **0.1.1** (published 2015-01-07) · MIT license · 0 weekly downloads

## Install

```sh
npm install reador-client
pnpm add reador-client
yarn add reador-client
bun add reador-client
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.1 |
| Published | 2015-01-07 |
| First published | 2015-01-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Node | 0.10.x |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Maintainers | a.pultier |
| Keywords | reador |

## Links

- npm: https://www.npmjs.com/package/reador-client
- Repository: https://github.com/SINTEF-9012/reador-node-client
- Issues: https://github.com/SINTEF-9012/reador-node-client/issues
- npm.io page: https://npm.io/package/reador-client

## Dependencies (1)

- [restler](https://npm.io/package/restler.md) ^3.2.2

## Recent versions

- 0.1.1 (latest) — 2015-01-07
- 0.1.0 — 2015-01-07

## README

Reador Node.js Client
=====================

Simple Node.js asynchronous client for [Reador.net](http://reador.net/).

### Installation

```npm install reador-client```

### Example

```javascript
var ReadorClient = require('reador-client');

var client = new ReadorClient("username", "password");

client.Search(["#duck", "#rabbit", "#cow"], function(search) {
	search.Load(function(items) {
		console.log(items);
	});
	search.TagsCloud(function(tags) {
		console.log(tags);
	});
});
```

### API

Simply Typescript's output.

```typescript
class Client {
    authentification: {
        username: string;
        password: string;
    };
    constructor(username: string, password: string);
    Searches(callback: (response: Search[]) => void): void;
    Search(tags: string[], callback: (search: Search) => void, params?: {
        lang?: string;
        name?: string;
    }): void;
    SearchLoadDelete(tags: string[], callback: (result: Item[]) => void): void;
    SearchTagsCloudDelete(tags: string[], callback: (result: Tag[]) => void): void;
}

class Search {
    id: number;
    name: string;
    createdAt: Date;
    lang: string;
    tags: string[];
    private _client;
    constructor(client: Client);
    TagsCloud(callback: (tags: Tag[]) => void): void;
    Load(callback: (tags: Item[]) => void): void;
    Delete(callback?: () => void): void;
}

interface Tag {
    text: string;
    link: string;
    weight: number;
    filter_type: string;
}

interface Item {
    uri: string;
    title: string;
    similarity: number;
    date: string;
    description: string[];
    filters: {
        filter_type?: string;
        prop?: string;
        uri?: string;
        value?: string;
        kind?: string;
    }[];
    props: {
        [x: string]: {
            [x: string]: {
                [x: string]: string;
            };
        };
    };
}
```

---
_Source: https://npm.io/package/reador-client · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._