README
nit-pipes
This is a collection of useful pipes for AngularIO (v>=4) with no external dependencies.
Table of contents
Installation
- Use npm to install the package
$ npm install @nudgeit/nit-pipes --save
- Add into your module
importstheNitPipesModulein order to add all of the pipes.
import {NitPipesModule} from ' @nudgeit/nit-pipes';
@NgModule({
// ...
imports: [
// ...
NitPipesModule
]
})
Pipes
first
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
<p>{{ [1, 2, 3, 4] | first: 2 }}</p> <!-- Output: "1, 2" -->
last
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
<p>{{ [1, 2, 3, 4] | last: 2 }}</p> <!-- Output: "3, 4" -->
join
Joins the elements of an array.
Usage: array | join: [separator|optional]
<p>{{ [1, 2] | join: ', ' }}</p> <!-- Output: "1, 2" -->
impureJoin
The impure version of join.
isArray
Tests if a value is an array and returns true if it is or false otherwise.
Usage: value | isArray
<p>{{ [1, 2] | isArray }}</p> <!-- Output: "true" -->
<p>{{ "12" | isArray }}</p> <!-- Output: "false" -->
isBoolean
Tests if a value is a boolean and returns true if it is or false otherwise.
Usage: value | isBoolean
<p>{{ false | isBoolean }}</p> <!-- Output: "true" -->
<p>{{ "12" | isBoolean }}</p> <!-- Output: "false" -->
isDate
Tests if a value is a date and returns true if it is or false otherwise.
Usage: value | isDate
isFunction
Tests if a value is a function and returns true if it is or false otherwise.
Usage: value | isFunction
isNull
Tests if a value is null or undefined and returns true if it is or false otherwise.
Usage: value | isNull
<p>{{ null | isNull }}</p> <!-- Output: "true" -->
<p>{{ undefined | isNull }}</p> <!-- Output: "true" -->
<p>{{ "12" | isNull }}</p> <!-- Output: "false" -->
<p>{{ "" | isNull }}</p> <!-- Output: "false" -->
isString
Tests if a value is a string and returns true if it is or false otherwise.
Usage: value | isString
safeUrl
Deprecated - better use safe!
Returns the safe version of an URL. Use this with care!
Usage: url | safeUrl
initials
Returns the initials of the words in a string.
Usage: string | join: [maxLength|optional, default:3]
<p>{{ "Nibo AI" | initials }}</p> <!-- Output: "NA" -->
safe
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.
<img [src]="url | safe: 'url'"/> <!-- Output: safe version of the URL -->
<script [src]="url | safe: 'resource_url'"></script> <!-- Output: safe version of the URL -->
<p [innerHtml]="content | safe: 'html'"></p> <!-- Output: necessary if content contains tags like SCRIPT -->
sanitize
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.
<img [src]="url | sanitize: 'url'"/> <!-- Output: safe version of the URL -->
<script [src]="url | sanitize: 'resource_url'"></script> <!-- Output: safe version of the URL -->
<p [innerHtml]="content | sanitize: 'html'"></p> <!-- Output: necessary if content contains tags like SCRIPT -->
xfilter
Joins the elements of an array.
Usage: array | xfilter: customFilter
isOdd = (x) => x % 2 === 1;
<p>{{ [1, 2, 3, 4] | xfilter: isOdd }}</p> <!-- Output: "1, 3" -->
Development
This section is solely for the developers of this library, not for its users/consumers.
Publish a new version
- Change the version in
package.json,package-lock.jsonandprojects\nit-pipes\package.json. - Run
npm run publish-lib. You'll need an OTP to authenticate and publish. - Push the changes in git.
- Create a new release on the GitHub site.