nit-pipes


This is a collection of useful pipes for AngularIO (v>=4) with no external dependencies.

Table of contents

- Installation
- Pipes
- first
- last
- impureJoin
- initials
- isArray
- isBoolean
- isDate
- isFunction
- isNull
- isString
- join
- ~safeUrl~
- safe
- sanitize
- xfilter

Installation

1. Use npm to install the package

``terminal
$ npm install @nudgeit/nit-pipes --save
`

2. Add into your module imports the NitPipesModule in order to add all of the pipes.

`typescript
import {NitPipesModule} from ' @nudgeit/nit-pipes';

@NgModule({
// ...
imports: [
// ...
NitPipesModule
]
})
`

Pipes

$3

Returns the first n elements of the array. Any negative value of n is treated as 0 and an empty array will be returned.

Usage: array | first: n

`html


{{ [1, 2, 3, 4] | first: 2 }}


`

$3

Returns the last n elements of the array. Any negative value of n is treated as 0 and an empty array will be returned.

Usage: array | last: n

`html


{{ [1, 2, 3, 4] | last: 2 }}


`

$3

Joins the elements of an array.

Usage: array | join: [separator|optional]

`html


{{ [1, 2] | join: ', ' }}


`

$3

The impure version of join.

$3

Tests if a value is an array and returns true if it is or false otherwise.

Usage: value | isArray

`html


{{ [1, 2] | isArray }}

{{ "12" | isArray }}

`

$3

Tests if a value is a boolean and returns true if it is or false otherwise.

Usage: value | isBoolean

`html


{{ false | isBoolean }}

{{ "12" | isBoolean }}

`

$3

Tests if a value is a date and returns true if it is or false otherwise.

Usage: value | isDate

$3

Tests if a value is a function and returns true if it is or false otherwise.

Usage: value | isFunction

$3

Tests if a value is null or undefined and returns true if it is or false otherwise.

Usage: value | isNull

`html


{{ null | isNull }}

{{ undefined | isNull }}

{{ "12" | isNull }}

{{ "" | isNull }}

`

$3

Tests if a value is a string and returns true if it is or false otherwise.

Usage: value | isString

$3

Deprecated - better use safe!

Returns the safe version of an URL. Use this with care!

Usage: url | safeUrl

$3

Returns the initials of the words in a string.

Usage: string | join: [maxLength|optional, default:3]

`html


{{ "Nibo AI" | initials }}


`

$3

Returns the safe version of an URL or HTML. Use this with care!

Usage: string | safe: context

Context can be one of 'HTML', 'STYLE', 'SCRIPT', 'URL', 'RESOURCE_URL' (case insensitive)
depending on what content you would like to sanitize.

`html





`

$3

Returns the sanitized version of an URL or HTML. Use this with care!

Usage: string | sanitize: context

Context can be one of 'HTML', 'STYLE', 'SCRIPT', 'URL', 'RESOURCE_URL' (case insensitive)
depending on what content you would like to sanitize.

`html





`

$3

Joins the elements of an array.

Usage: array | xfilter: customFilter

`typescript
isOdd = (x) => x % 2 === 1;
`

`html


{{ [1, 2, 3, 4] | xfilter: isOdd }}


`

Development

This section is solely for the developers of this library, not for its users/consumers.

$3

1. Change the version in package.json, package-lock.json and projects\nit-pipes\package.json.
2. Run npm run publish-lib`. You'll need an OTP to authenticate and publish.
3. Push the changes in git.
4. Create a new release on the GitHub site.