Striptags

https://www.npmjs.com/package/striptags
Admin
Striptags is an implementation of PHP's strip_tags function for Node.js that removes HTML tags from...
Tokens:3,709
Snippets:71
Trust Score:9.6
Update:6 months ago
Show doc for...
Tokens:
Raw
### Installation

Source: https://www.npmjs.com/package/striptags

Install the striptags package using npm.

```APIDOC
## Installation

Install the striptags package using npm.

### Command
```bash
npm install striptags
```
```

--------------------------------

### Install via npm shorthand

Source: https://www.npmjs.com/package/striptags/v/3.2.0?activeTab=dependencies

Alternative command to install the package.

```bash
npm i striptags
```

--------------------------------

### Install striptags (short version)

Source: https://www.npmjs.com/package/striptags/v/3.2.0?activeTab=readme

A shorter alias for installing the striptags package using npm. This is a common shorthand for the installation command.

```bash
npm i striptags

```

--------------------------------

### Install striptags

Source: https://www.npmjs.com/package/striptags/v/3.2.0?activeTab=dependencies

Command to install the package via npm.

```bash
npm install striptags
```

--------------------------------

### Install striptags

Source: https://www.npmjs.com/package/striptags?activeTab=dependents

Command to install the package via npm.

```bash
npm install striptags
```

```bash
npm i striptags
```

--------------------------------

### Strip HTML Tags Example

Source: https://www.npmjs.com/package/striptags/v/3.2.0?activeTab=dependencies

Demonstrates stripping tags with various configurations for allowed tags and replacements.

```javascript
var striptags = require('striptags');

var html =
    '<a href="https://example.com">' +
        'lorem ipsum <strong>dolor</strong> <em>sit</em> amet' +
    '</a>';

striptags(html);
striptags(html, '<strong>');
striptags(html, ['a']);
striptags(html, [], '\n');
```

--------------------------------

### striptags output examples

Source: https://www.npmjs.com/package/striptags?activeTab=versions

Illustrates the output of the striptags function with different configurations. Each example shows the result of stripping HTML tags with varying allowed tags or replacement characters.

```text
'lorem ipsum dolor sit amet'

```

```text
lorem ipsum <strong>dolor</strong> sit amet'

```

```text
'<a href="https://example.com">lorem ipsum dolor sit amet</a>'

```

```text
lorem ipsum 
dolor
 
sit
 amet


```

--------------------------------

### Install striptags package

Source: https://www.npmjs.com/package/striptags?activeTab=versions

Install the striptags package using npm. This command adds the package to your project's dependencies.

```bash
npm install striptags

```

--------------------------------

### striptags Output Examples

Source: https://www.npmjs.com/package/striptags?activeTab=code

Illustrates the different outputs produced by the striptags function based on various configurations of allowed tags and replacement strings.

```text
'lorem ipsum dolor sit amet'

```

```text
lorem ipsum <strong>dolor</strong> sit amet'

```

```text
'<a href="https://example.com">lorem ipsum dolor sit amet</a>'

```

```text
lorem ipsum 

```

```text
dolor

```

```text
 

```

```text
sit

```

```text
 amet

```

--------------------------------

### Run Tests and Coverage

Source: https://www.npmjs.com/package/striptags/v/3.2.0?activeTab=dependencies

Commands to execute tests and generate coverage reports.

```bash
npm test
```

```bash
npm run coverage
```

--------------------------------

### Tests

Source: https://www.npmjs.com/package/striptags

Instructions on how to run tests and generate code coverage.

```APIDOC
## Tests

You can run tests locally using npm.

### Running Tests
```bash
npm test
```

### Generating Test Coverage
Generate test coverage using istanbul.

```bash
npm run coverage
```
```

--------------------------------

### Basic Usage

Source: https://www.npmjs.com/package/striptags

Demonstrates how to use the striptags function with different parameters.

```APIDOC
## Basic Usage

The `striptags` function can be used to remove HTML tags from a string. It accepts an optional second argument for allowed tags and an optional third argument for tag replacement.

### Function Signature
```javascript
striptags(html, allowed_tags, tag_replacement);
```

### Parameters
- **html** (string) - The HTML string to strip tags from.
- **allowed_tags** (string or array) - Optional. A string or array of HTML tags to allow.
- **tag_replacement** (string) - Optional. The string to replace stripped tags with.

### Example
```javascript
var striptags = require('striptags');

var html = '<a href="https://example.com">lorem ipsum <strong>dolor</strong> <em>sit</em> amet</a>';

// Remove all tags
console.log(striptags(html));
// Output: 'lorem ipsum dolor sit amet'

// Allow only <strong> tags
console.log(striptags(html, '<strong>'));
// Output: 'lorem ipsum <strong>dolor</strong> sit amet'

// Allow only <a> tags
console.log(striptags(html, ['a']));
// Output: '<a href="https://example.com">lorem ipsum dolor sit amet</a>'

// Replace stripped tags with newline characters
console.log(striptags(html, [], '\n'));
// Output:
// lorem ipsum 
// dolor
// 
// sit
//  amet
```
```

--------------------------------

### Basic Usage Syntax

Source: https://www.npmjs.com/package/striptags/v/3.2.0?activeTab=dependencies

The function signature for stripping HTML tags.

```javascript
striptags(html, allowed_tags, tag_replacement);
```

--------------------------------

### Run striptags tests

Source: https://www.npmjs.com/package/striptags?activeTab=versions

Executes the test suite for the striptags package using npm. This command is typically used to verify the package's functionality and ensure it behaves as expected.

```bash
npm test

```

--------------------------------

### Basic striptags usage

Source: https://www.npmjs.com/package/striptags?activeTab=versions

Demonstrates the basic usage of the striptags function. It shows how to remove all HTML tags, allow specific tags, and use a tag replacement character.

```javascript
var striptags = require('striptags');

var html =
    '<a href="https://example.com">' +
        'lorem ipsum <strong>dolor</strong> <em>sit</em> amet' +
    '</a>';

striptags(html);
striptags(html, '<strong>');
striptags(html, ['a']);
striptags(html, [], '\n');

```

--------------------------------

### Streaming Mode Usage

Source: https://www.npmjs.com/package/striptags/v/3.2.0?activeTab=dependencies

Initializes a streaming function to process partial HTML chunks while maintaining state.

```javascript
let stream_function = striptags.init_streaming_mode(
    allowed_tags,
    tag_replacement
);

let partial_text = stream_function(partial_html);
let more_text    = stream_function(more_html);
```

--------------------------------

### Streaming Mode

Source: https://www.npmjs.com/package/striptags

Utilize striptags in streaming mode for processing partial HTML content.

```APIDOC
## Streaming Mode

`striptags` can also operate in streaming mode. This is useful for processing HTML content in chunks.

### Initialization
Call `init_streaming_mode` to get a function that accepts HTML and outputs stripped HTML. State is saved between calls.

### Function Signature
```javascript
let stream_function = striptags.init_streaming_mode(allowed_tags, tag_replacement);
```

### Parameters
- **allowed_tags** (string or array) - Optional. A string or array of HTML tags to allow.
- **tag_replacement** (string) - Optional. The string to replace stripped tags with.

### Usage
```javascript
let stream_function = striptags.init_streaming_mode();

let partial_text = stream_function('<p>This is ');
let more_text    = stream_function('the first part.</p>');

console.log(partial_text + more_text);
// Output: 'This is the first part.'
```

Refer to `test/striptags-test.js` for a concrete example.
```

--------------------------------

### Initialize striptags streaming mode

Source: https://www.npmjs.com/package/striptags?activeTab=versions

Initializes striptags in streaming mode, returning a function that processes HTML in chunks. This is useful for handling large HTML content or data streams.

```javascript
let stream_function = striptags.init_streaming_mode(
    allowed_tags,
    tag_replacement
);

let partial_text = stream_function(partial_html);
let more_text    = stream_function(more_html);

```

--------------------------------

### Generate striptags test coverage

Source: https://www.npmjs.com/package/striptags?activeTab=versions

Generates a test coverage report for the striptags package using npm and istanbul. This helps in understanding which parts of the code are covered by tests.

```bash
npm run coverage

```
Tokens:
Raw