# jStrip
[](https://nodei.co/npm/jstrip/)
[](https://travis-ci.org/frankc60/jStrip)
[](https://david-dm.org/frankc60/jStrip)
[](https://coveralls.io/github/frankc60/jStrip)
[](https://gitter.im/jStrip_npm/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
jStrip is written to run with Node.js and let's you easily grab data from the web - from `json`, `html`, `array`, `number` or from text and apply multiple filters to change the data to your liking, before it is returned to you asynchronously. jStrip works great with `json` formats, making json API work a breeze. Also apply **jQuery** to `html` pages, locally or from the web.
Use **chainable methods** and **event handlers** to enhance jStrip, with new features being added regularly.
To migrate any `v1.x` code see the [Migration section](#migrating-from-version-1-to-version-2) below.
#### Chuck Norris Random Joke - json api
```js
const jStrip = require("jstrip");
const chuckNJoke = new jStrip();
//display random chuck norris joke
chuckNJoke.on('m1', (d) => {
let pJson = JSON.parse(d.data);
console.log(`Chuck Norris Joke: ${pJson.value}`);
});
chuckNJoke.getData("https://api.chucknorris.io/jokes/random")
.marker("m1").jpretty().show();
//jpretty layouts json in easy to read format
```
Check out more [Examples](#examples) below.
***
**Table of Contents**
- [Installation](#installation)
- [Chainable Methods](#chainable-methods)
- [first - getData()](#first-method---getdata-url--text--json--array--number-)
- [show()](#show)
- [pretty()](#pretty)
- [jpretty()](#jpretty)
- [selector()](#selector-jquery-)
- [replace()](#replace-pattern--text-)
- [removehtml()](#removehtml)
- [uppercase()](#uppercase)
- [lowercase()](#lowercase)
- [sort()](#sort)
- [reverse()](#reverse)
- [add()](#add-number-)
- [minus()](#minus-number-)
- [Async Event Handler](#async-event-handlers-marker-and-on)
- [marker()](#marker-eventname-)
- [on()](#on-marker-name--callback-fnreturned-data-)
- [Migration from v.1.x](#migrating-from-version-1-to-version-2)
- [_jStrip()](#_jstrip-url-jquery-)
- [Examples](##examples)
- [Chuck Norris Random Jokes](#chuck-norris-random-joke---json-api-1)
- [Live Bitcoin Rates](#live-bitcoin-rates---json-api)
- [Live Time in New Zealand](#live-time-in-new-zealand---html)
- [Text Change](#textchange---text)
- [Add / Subtract](#addsubtract---number)
- [Testing](#tests)
- [Versioning](#versioning)
- [Getting Involved](#get-involved)
- [Issues](#issues)
- [Contributing](#contributing)
- [Authors](#authors)
- [Licence](#license)
***
## Installation
Install **jstrip** with [npm](https://www.npmjs.com/):
```sh
$ npm i -S jstrip
```
Include **jStrip** and create an instance.
```js
const jStrip = require('jstrip'); //top of file
...
let jStrip1 = new jStrip();
```
## Chainable Methods
jStrip allows you to append as many filters as you like by simply chaining methods together with a dot delimiter. For example:
```js
jStrip4.getData('https://goo.gl/e234y2').selector("div#rs1")
.selector("#i_time").pretty()
.show(); //displays current time in new zealand
```
### First method - .getData( *url* | *text* | *json* | *array* | *number* )
The only requirement is to first grab the data. Start by using the `.getData()` method.
`getData()` accepts 3 string types: a **"url"**, **"text"** or **json**. If a **url** returns `json`, the type will become **json**.
```js
jStrip1.getData("http://www.google.com") // url
//or
jStrip1.getData("my own string of text here!") // string
//or
jStrip1.getData({ name: "New York", high: 47.3, low: 42 }) // json
jStrip1.getData('{ name: "London", high: 30, low: 28.5 }') // json
// (as a string)
jStrip.getData(168) // number
//or
jStrip1.getData("http://prices.com/btc/api/data.json") // json
```
If you use a **url** the default timeout for the http/s request is 10000 milli-seconds. You can change this per instance by changing the `timeout` property.
```js
jStrip1.timeout = 15000;
console.log(jStrip1.timeout); // 15000 - 15 seconds
```
### .show()
`show()` displays the contents to the console. Great for seeing the results, see **.marker() and .on()** below to add an event handler.
```js
jStrip1.getData("hello world").show() //hello world
```
### .pretty()
`pretty()` will format the data it is given. This is great for tidying html, xml or standard text.
```js
jStrip1.getData("hello world")
.pretty().show(); // hello world (removes extra spaces)
```
### .jpretty()
Make `json` data more readable in a key=value layout. `jpretty()` outputs the `json` format into an easy to read layout.
```js
const jStrip18 = new jStrip();
jStrip18.on('m1', (d) => {
let pJson = JSON.parse(d.data); // need to parse the json before
console.log(`data type: ${d.type}`);// accessing it's properties
console.log(`Bitcoin-USD rate: ${pJson.bpi.USD.rate}`);
}); // .bpi.USD.rate is easy seen from jpretty output
jStrip18.getData("https://api.coindesk.com/v1/bpi/currentprice/gbp.json")
.marker("m1").jpretty().show();
```
`jpretty().show()` console output of json:
```sh
{}.bpi.USD.code = USD
{}.bpi.USD.rate = 8,262.8113
{}.bpi.USD.description = United States Dollar
{}.bpi.USD.rate_float = 8262.8113
```
`jpretty()` outputs the `json` into a dot delimited layout of key = value, making it easy to identify its fields and values. **Note** that `jpretty()` changes the `json` into a different format, so any property access using the object must be performed beforehand, as in the example above.
### .selector(*jquery*)
`selector()` lets you grabs html from the data using **jQuery** functionality. Check out the many available [jQuery selectors](https://api.jquery.com/category/selectors/) you can use.
```js
jStrip1.getData("http://www.news.com")
.selector("div#top li:nth-child(2)")
.show(); //2nd li tag inside div with id 'top'
```
### .replace(*pattern*, *text*)
Use a [regular expression](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions) or string pattern to search the jStrip content, followed by the replacement string.
```js
jStrip5.getData('hello world').replace(/hello/,"ki ora")
.show() // ki ora world
```
### .removehtml()
html elements are stripped out.
```js
jStrip5.getData(' world
').removehtml()
.show() // hello world
```
### .uppercase()
convert string contents to upper case.
```js
jStrip5.getData('hello world').uppercase()
.show() // HELLO WORLD
```
### .lowercase()
convert string contents to lower case.
```js
jStrip5.getData('HELLO WORLD').lowercase()
.show() // hello world
```
### .sort()
sorts an `array`, `string` or `url` contents into alphabetical / numeric order.
```js
jStrip5.getData([1,5,3,6,2,4]).sort()
.show() //[ 1, 2, 3, 4, 5 ]
```
The `string` / `url` has a maximum string length of 100 characters.
### .reverse()
convert an `array`, `string` or `url` into reverse order.
```js
jStrip5.getData([1,2,3,4,5]).reverse()
.show() //[ 5, 4, 3, 2, 1 ]
```
The `string` / `url` has a maximum string length of 100 characters.
### .add(*number*)
performs an mathematical **addition**.
The getData value needs to be a **number**.
```js
jStrip5.getData(1500).add(500)
.show() // 2000
```
### .minus(*number*)
performs an mathematical **subtraction**.
The getData value needs to be a **number**.
```js
jStrip5.getData(1500).minus(500)
.show() // 1000
```
## Async Event Handlers .marker() and .on()
Grabbing data from the web is not instant, so jStrip **caches** the filters and provides an **event handler** to tell you when it has all it's data ready, and send it asynchronously without blocking.
Set a **marker** (or many) in your jStrip call, simply by using the **marker()** method and giving it a unique name.
#### .marker(*eventname*)
```js
jStrip1.getData("have a nice day")
.marker("marker1") // 1st marker
.pretty().marker("marker2"); // 2nd marker
```
Display the markers asynchronously with the **on()** event handler.
Two parameters are needed: the named marker() to trigger on followed with a function,
jStrip returns an object to the function, with 4 properties:
- `data` - containing the content, as a string
- `type` - datatype (*string* | *url* | *json* )
- `url` - url address used if type = 'url', otherwise equals `undefined`.
#### .on( *marker name*, *callback fn(returned data)* )
```js
jStrip1.on("marker1",(d) => { // first marker
console.log(`html ${d.data}`); // have a nice day
console.log(`datatype ${d.type}`); // string
console.log(`url ${d.url}`); // undefined as type=string
});
jStrip1.on("marker2",(d) => { // second marker
console.log(`pretty html ${d.data}`); // have a nice day
});
```
- The **on()** event handler(s) should be placed before the **marker()** is set.
## Migrating from Version 1 to Version 2
To keep your `v 1.x` code working with `v 2.x`, make these two simple updates to your existing code:
- Create a seperate instance for each jStrip call, with the **new** operator.
```js
let jStripInstance1 = new jStrip(); //new version 2 way
```
- Replace your jStrip call with _jStrip():
```js
jStrip("","") //older version 1 way
```
to
```js
jStripInstance1._jStrip("","") //new version 2 way
```
That's all!
You can still use `Version 1` features together with `Version 2`.
## _jStrip( *"url", "jquery"* )
_jStrip() returns data via a **Promise** or as **Async/Await**.
### Using Promises
```js
// Using Promise
jStripInstance1._jStrip('https://www.bing.com', "$('title').html()")
.then((result) => {
console.log(`promise result: ${result.data}
time taken: ${result.timed}
uri: ${result.uri}
jquery: ${result.jquery}`);
})
.catch((e) => {
console.log(`Error: ${e}`);
});
```
### Using Async/Await
```js
// Using Async/Await
const fn = (async () => {
try {
const result = await jStripInstance1._jStrip('https://www.youtube.com', "$('title').html()");
await console.log(`async/await result: ${result.data}
time taken: ${result.timed}
uri: ${result.uri}
jquery: ${result.jquery}`);
} catch (err) {
console.log(`error ${err}`);
}
})();
```
## Examples
#### Chuck Norris Random Joke - json api
```js
const jStrip = require("jstrip");
const chuckNJoke = new jStrip();
//display random chuck norris joke
chuckNJoke.on('m1', (d) => {
let pJson = JSON.parse(d.data);
console.log(`Chuck Norris Joke: ${pJson.value}`);
});
chuckNJoke.getData("https://api.chucknorris.io/jokes/random")
.marker("m1").jpretty().show();
//jpretty layouts json in easy to read format
```
#### Live Bitcoin Rates - json api
```js
const bitcoinRates = new jStrip();
bitcoinRates.on('m1', (d) => {
let pJson = JSON.parse(d.data);
console.log(` updated: ${pJson.time.updated}
1 Bitcoin/USD rate: $${pJson.bpi.USD.rate}`);
});
bitcoinRates.getData("https://api.coindesk.com/v1/bpi/currentprice/gbp.json")
.marker("m1");
```
#### Live Time in New Zealand - html
```js
const nzTime = new jStrip();
nzTime.on("nztime", (d) => {
console.log(`Time in NZ now is: ${d.data}`);
})
nzTime.getData('https://goo.gl/e234y2').selector("div#rs1")
.selector("#i_time").marker("nztime");
```
#### textchange - text
```js
const text = new jStrip();
text.on("txt", (d) => {
console.log(`text: ${d.data}`);
})
text.getData('hello world. npm rules!')
.pretty().show()
.removehtml().marker("txt")
.uppercase()..marker("txt")
.lowercase().show()
.reverse().marker("txt");
```
#### add/subtract - number
```js
const num = new jStrip();
num.on("updateSum", (d) => {
console.log(`Update Amount: ${d.data}`);
})
num.getData(67895.42).marker("updateSum")
.minus(75.99).marker("updateSum")
.minus(32.00).marker("updateSum").show()
.add(137.50).marker("updateSum")
.minus(12.95).marker("updateSum");
```
## Tests
Automated CI test builds are run with each update. [](https://travis-ci.org/frankc60/jStrip) [](https://coveralls.io/github/frankc60/jStrip)
## Versioning
We use [SemVer](http://semver.org/) for versioning.
## Get Involved
### Issues
If you have an issue, or a bug let us know and we will do our best.
Create an issue [here](https://github.com/frankc60/jStrip/issues).
### Contributing
If you have any questions, comments, suggestions or ideas, feel free to drop me a line. [](https://gitter.im/jStrip_npm/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
We'd love to hear your suggestions and ideas!
## Authors
- **Frank C** - [frankc60](https://github.com/frankc60)
## License
This project is licensed under the MIT License. [](https://github.com/frankc60/jStrip/blob/master/LICENSE)