https://github.com/smartive/proc-that-rest-extractor

Extractor for proc-that. Loads items from REST APIs
https://github.com/smartive/proc-that-rest-extractor

Last synced: about 5 hours ago
JSON representation

Extractor for proc-that. Loads items from REST APIs

• Host: GitHub
• URL: https://github.com/smartive/proc-that-rest-extractor
• Owner: smartive
• License: mit
• Created: 2016-03-28T09:04:01.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-13T23:29:05.000Z (6 months ago)
• Last Synced: 2024-10-03T06:54:16.787Z (about 1 month ago)
• Language: TypeScript
• Homepage: http://smartive.github.io/proc-that-rest-extractor
• Size: 306 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# RestExtractor

Modular extractor for `proc-that`. Loads items from REST APIs via http requests.

Uses [restler](https://github.com/danwrong/restler) for downloading resources.

##### A bunch of badges

[![Build Status](https://travis-ci.org/smartive/proc-that-rest-extractor.svg?maxAge=3600)](https://travis-ci.org/smartive/proc-that-rest-extractor)

[![Build Status](https://ci.appveyor.com/api/projects/status/8juee9m6sycve394?svg=true)](https://ci.appveyor.com/project/buehler/proc-that-rest-extractor)

[![npm](https://img.shields.io/npm/v/proc-that-rest-extractor.svg?maxAge=3600)](https://www.npmjs.com/package/proc-that-rest-extractor)

[![Coverage status](https://img.shields.io/coveralls/smartive/proc-that-rest-extractor.svg?maxAge=3600)](https://coveralls.io/github/smartive/proc-that-rest-extractor)

[![license](https://img.shields.io/github/license/smartive/proc-that-rest-extractor.svg?maxAge=2592000)](https://github.com/smartive/proc-that-rest-extractor)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Greenkeeper badge](https://badges.greenkeeper.io/smartive/proc-that-rest-extractor.svg)](https://greenkeeper.io/)

## Installation

```bash

npm install --save proc-that-rest-extractor

```

## Usage

```typescript

import {Etl} from 'proc-that';

import {RestExtractor} from 'proc-that-rest-extractor';

let extractor = new RestExtractor('http://my-rest-url.com/posts');

new Etl().addExtractor(extractor).start().subscribe(/*...*/);

```

### Custom result set

If the called API delivers a masked result (i.e. a JSON object with a `data` property)

you can pass a function into the constructor that is called on the result.

```typescript

import {Etl} from 'proc-that';

import {RestExtractor, RestExtractorMethod} from 'proc-that-rest-extractor';

let extractor = new RestExtractor('http://my-rest-url.com/posts', RestExtractorMethod.Get, result => result.data);

new Etl().addExtractor(extractor).start().subscribe(/*...*/);

```