@rxap/pipes
Version:
Provides a set of Angular pipes for common data transformations, including currency formatting, string manipulation, and object property access. These pipes offer standalone functionality for easy integration into Angular templates. The package includes p
2,090 lines • 51.8 kB
JSON
{
"id": 0,
"name": "@rxap/pipes",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 13,
"name": "CurrencyPipeModule",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 14,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 15,
"name": "CurrencyPipeModule",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 13,
"name": "CurrencyPipeModule",
"package": "@rxap/pipes"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [
14
]
}
],
"sources": [
{
"fileName": "currency.pipe.ts",
"line": 67,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/currency.pipe.ts#L67"
}
]
},
{
"id": 16,
"name": "DeleteIdentifierPipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 17,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 18,
"name": "DeleteIdentifierPipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 16,
"name": "DeleteIdentifierPipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 19,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "delete-identifier.pipe.ts",
"line": 18,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/delete-identifier.pipe.ts#L18"
}
],
"signatures": [
{
"id": 20,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "delete-identifier.pipe.ts",
"line": 18,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/delete-identifier.pipe.ts#L18"
}
],
"typeParameters": [
{
"id": 21,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {}
}
],
"parameters": [
{
"id": 22,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "unknown",
"name": "WithIdentifier & T"
}
]
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "reference",
"target": 21,
"name": "T",
"package": "@rxap/pipes",
"refersToTypeParameter": true
}
]
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
17
]
},
{
"title": "Methods",
"children": [
19
]
}
],
"sources": [
{
"fileName": "delete-identifier.pipe.ts",
"line": 16,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/delete-identifier.pipe.ts#L16"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 23,
"name": "EscapeQuotationMarkPipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 24,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 25,
"name": "EscapeQuotationMarkPipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 23,
"name": "EscapeQuotationMarkPipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 26,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "escape-quotation-mark.pipe.ts",
"line": 13,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/escape-quotation-mark.pipe.ts#L13"
}
],
"signatures": [
{
"id": 27,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "escape-quotation-mark.pipe.ts",
"line": 13,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/escape-quotation-mark.pipe.ts#L13"
}
],
"parameters": [
{
"id": 28,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 29,
"name": "reverse",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "boolean"
},
"defaultValue": "false"
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
24
]
},
{
"title": "Methods",
"children": [
26
]
}
],
"sources": [
{
"fileName": "escape-quotation-mark.pipe.ts",
"line": 11,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/escape-quotation-mark.pipe.ts#L11"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 30,
"name": "GetFromObjectPipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 31,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 32,
"name": "GetFromObjectPipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 30,
"name": "GetFromObjectPipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 33,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "get-from-object.pipe.ts",
"line": 12,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/get-from-object.pipe.ts#L12"
}
],
"signatures": [
{
"id": 34,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "get-from-object.pipe.ts",
"line": 12,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/get-from-object.pipe.ts#L12"
}
],
"parameters": [
{
"id": 35,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 36,
"name": "path",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "any"
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
31
]
},
{
"title": "Methods",
"children": [
33
]
}
],
"sources": [
{
"fileName": "get-from-object.pipe.ts",
"line": 11,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/get-from-object.pipe.ts#L11"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 37,
"name": "JoinPipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 38,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 39,
"name": "JoinPipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 37,
"name": "JoinPipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 40,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "join.pipe.ts",
"line": 13,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/join.pipe.ts#L13"
}
],
"signatures": [
{
"id": 41,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "join.pipe.ts",
"line": 13,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/join.pipe.ts#L13"
}
],
"parameters": [
{
"id": 42,
"name": "list",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "array",
"elementType": {
"type": "intrinsic",
"name": "any"
}
}
},
{
"id": 43,
"name": "separator",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
38
]
},
{
"title": "Methods",
"children": [
40
]
}
],
"sources": [
{
"fileName": "join.pipe.ts",
"line": 11,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/join.pipe.ts#L11"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 44,
"name": "LimitPipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 45,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 46,
"name": "LimitPipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 44,
"name": "LimitPipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 47,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "limit.pipe.ts",
"line": 12,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/limit.pipe.ts#L12"
}
],
"signatures": [
{
"id": 48,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "limit.pipe.ts",
"line": 12,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/limit.pipe.ts#L12"
}
],
"typeParameters": [
{
"id": 49,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {}
}
],
"parameters": [
{
"id": 50,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "typeOperator",
"operator": "readonly",
"target": {
"type": "array",
"elementType": {
"type": "reference",
"target": 49,
"name": "T",
"package": "@rxap/pipes",
"refersToTypeParameter": true
}
}
}
},
{
"id": 51,
"name": "limit",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": 49,
"name": "T",
"package": "@rxap/pipes",
"refersToTypeParameter": true
}
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
45
]
},
{
"title": "Methods",
"children": [
47
]
}
],
"sources": [
{
"fileName": "limit.pipe.ts",
"line": 10,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/limit.pipe.ts#L10"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 52,
"name": "ReplacePipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 53,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 54,
"name": "ReplacePipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 52,
"name": "ReplacePipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 55,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "replace.pipe.ts",
"line": 12,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/replace.pipe.ts#L12"
}
],
"signatures": [
{
"id": 56,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "replace.pipe.ts",
"line": 12,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/replace.pipe.ts#L12"
}
],
"parameters": [
{
"id": 57,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 58,
"name": "replace",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "RegExp"
},
"name": "RegExp",
"package": "typescript"
}
},
{
"id": 59,
"name": "replaceValue",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
53
]
},
{
"title": "Methods",
"children": [
55
]
}
],
"sources": [
{
"fileName": "replace.pipe.ts",
"line": 10,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/replace.pipe.ts#L10"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 1,
"name": "RxapCurrencyPipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 2,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "currency.pipe.ts",
"line": 14,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/currency.pipe.ts#L14"
}
],
"signatures": [
{
"id": 3,
"name": "RxapCurrencyPipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "currency.pipe.ts",
"line": 14,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/currency.pipe.ts#L14"
}
],
"parameters": [
{
"id": 4,
"name": "currency",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/common/index.d.ts",
"qualifiedName": "CurrencyPipe"
},
"name": "CurrencyPipe",
"package": "@angular/common"
}
}
],
"type": {
"type": "reference",
"target": 1,
"name": "RxapCurrencyPipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 6,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "currency.pipe.ts",
"line": 50,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/currency.pipe.ts#L50"
}
],
"signatures": [
{
"id": 7,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "currency.pipe.ts",
"line": 50,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/currency.pipe.ts#L50"
}
],
"parameters": [
{
"id": 8,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {},
"comment": {
"summary": [
{
"kind": "text",
"text": "The number to be formatted as currency."
}
]
},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 9,
"name": "currencyCode",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) currency code,\nsuch as "
},
{
"kind": "code",
"text": "`USD`"
},
{
"kind": "text",
"text": " for the US dollar and "
},
{
"kind": "code",
"text": "`EUR`"
},
{
"kind": "text",
"text": " for the euro. The default currency code can be\nconfigured using the "
},
{
"kind": "code",
"text": "`DEFAULT_CURRENCY_CODE`"
},
{
"kind": "text",
"text": " injection token."
}
]
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 10,
"name": "display",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "The format for the currency indicator. One of the following:\n - "
},
{
"kind": "code",
"text": "`code`"
},
{
"kind": "text",
"text": ": Show the code (such as "
},
{
"kind": "code",
"text": "`USD`"
},
{
"kind": "text",
"text": ").\n - "
},
{
"kind": "code",
"text": "`symbol`"
},
{
"kind": "text",
"text": "(default): Show the symbol (such as "
},
{
"kind": "code",
"text": "`$`"
},
{
"kind": "text",
"text": ").\n - "
},
{
"kind": "code",
"text": "`symbol-narrow`"
},
{
"kind": "text",
"text": ": Use the narrow symbol for locales that have two symbols for their\ncurrency.\nFor example, the Canadian dollar CAD has the symbol "
},
{
"kind": "code",
"text": "`CA$`"
},
{
"kind": "text",
"text": " and the symbol-narrow "
},
{
"kind": "code",
"text": "`$`"
},
{
"kind": "text",
"text": ". If the\nlocale has no narrow symbol, uses the standard symbol for the locale.\n - String: Use the given string value instead of a code or a symbol.\nFor example, an empty string will suppress the currency & symbol.\n - Boolean (marked deprecated in v5): "
},
{
"kind": "code",
"text": "`true`"
},
{
"kind": "text",
"text": " for symbol and false for "
},
{
"kind": "code",
"text": "`code`"
},
{
"kind": "text",
"text": "."
}
]
},
"type": {
"type": "union",
"types": [
{
"type": "intrinsic",
"name": "string"
},
{
"type": "intrinsic",
"name": "boolean"
}
]
}
},
{
"id": 11,
"name": "digitsInfo",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "Decimal representation options, specified by a string\nin the following format:<br>\n<code>{minIntegerDigits}.{minFractionDigits}-{maxFractionDigits}</code>.\n - "
},
{
"kind": "code",
"text": "`minIntegerDigits`"
},
{
"kind": "text",
"text": ": The minimum number of integer digits before the decimal point.\nDefault is "
},
{
"kind": "code",
"text": "`1`"
},
{
"kind": "text",
"text": ".\n - "
},
{
"kind": "code",
"text": "`minFractionDigits`"
},
{
"kind": "text",
"text": ": The minimum number of digits after the decimal point.\nDefault is "
},
{
"kind": "code",
"text": "`2`"
},
{
"kind": "text",
"text": ".\n - "
},
{
"kind": "code",
"text": "`maxFractionDigits`"
},
{
"kind": "text",
"text": ": The maximum number of digits after the decimal point.\nDefault is "
},
{
"kind": "code",
"text": "`2`"
},
{
"kind": "text",
"text": ".\nIf not provided, the number will be formatted with the proper amount of digits,\ndepending on what the [ISO 4217](https://en.wikipedia.org/wiki/ISO_4217) specifies.\nFor example, the Canadian dollar has 2 digits, whereas the Chilean peso has none."
}
]
},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 12,
"name": "locale",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"comment": {
"summary": [
{
"kind": "text",
"text": "A locale code for the locale format rules to use.\nWhen not supplied, uses the value of "
},
{
"kind": "code",
"text": "`LOCALE_ID`"
},
{
"kind": "text",
"text": ", which is "
},
{
"kind": "code",
"text": "`en-US`"
},
{
"kind": "text",
"text": " by default.\nSee [Setting your app locale]("
},
{
"kind": "relative-link",
"text": "guide/i18n#setting-up-the-locale-of-your-app"
},
{
"kind": "text",
"text": ")."
}
]
},
"type": {
"type": "intrinsic",
"name": "string"
}
}
],
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
2
]
},
{
"title": "Methods",
"children": [
6
]
}
],
"sources": [
{
"fileName": "currency.pipe.ts",
"line": 12,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/currency.pipe.ts#L12"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 60,
"name": "SlicePipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 61,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 62,
"name": "SlicePipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 60,
"name": "SlicePipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 63,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "slice.pipe.ts",
"line": 12,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/slice.pipe.ts#L12"
}
],
"signatures": [
{
"id": 64,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "slice.pipe.ts",
"line": 12,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/slice.pipe.ts#L12"
}
],
"typeParameters": [
{
"id": 65,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {}
}
],
"parameters": [
{
"id": 66,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "typeOperator",
"operator": "readonly",
"target": {
"type": "array",
"elementType": {
"type": "reference",
"target": 65,
"name": "T",
"package": "@rxap/pipes",
"refersToTypeParameter": true
}
}
}
},
{
"id": 67,
"name": "start",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
}
},
{
"id": 68,
"name": "end",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "intrinsic",
"name": "number"
}
}
],
"type": {
"type": "array",
"elementType": {
"type": "reference",
"target": 65,
"name": "T",
"package": "@rxap/pipes",
"refersToTypeParameter": true
}
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
61
]
},
{
"title": "Methods",
"children": [
63
]
}
],
"sources": [
{
"fileName": "slice.pipe.ts",
"line": 10,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/slice.pipe.ts#L10"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 69,
"name": "ToDisplayPipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 70,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 71,
"name": "ToDisplayPipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 69,
"name": "ToDisplayPipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 73,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "to-display.pipe.ts",
"line": 16,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/to-display.pipe.ts#L16"
}
],
"signatures": [
{
"id": 74,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "to-display.pipe.ts",
"line": 16,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/to-display.pipe.ts#L16"
}
],
"parameters": [
{
"id": 75,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "any"
}
},
{
"id": 76,
"name": "toDisplay",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "packages/utilities/src/lib/helpers.ts",
"qualifiedName": "ToDisplayFunction"
},
"name": "ToDisplayFunction",
"package": "@rxap/utilities"
},
"defaultValue": "..."
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
70
]
},
{
"title": "Methods",
"children": [
73
]
}
],
"sources": [
{
"fileName": "to-display.pipe.ts",
"line": 12,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/to-display.pipe.ts#L12"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
},
{
"id": 77,
"name": "TruncatePipe",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 78,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"signatures": [
{
"id": 79,
"name": "TruncatePipe",
"variant": "signature",
"kind": 16384,
"flags": {},
"type": {
"type": "reference",
"target": 77,
"name": "TruncatePipe",
"package": "@rxap/pipes"
}
}
]
},
{
"id": 80,
"name": "transform",
"variant": "declaration",
"kind": 2048,
"flags": {},
"sources": [
{
"fileName": "truncate.pipe.ts",
"line": 12,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/truncate.pipe.ts#L12"
}
],
"signatures": [
{
"id": 81,
"name": "transform",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "truncate.pipe.ts",
"line": 12,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/truncate.pipe.ts#L12"
}
],
"parameters": [
{
"id": 82,
"name": "value",
"variant": "param",
"kind": 32768,
"flags": {
"isOptional": true
},
"type": {
"type": "union",
"types": [
{
"type": "literal",
"value": null
},
{
"type": "intrinsic",
"name": "string"
}
]
}
},
{
"id": 83,
"name": "length",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "number"
},
"defaultValue": "64"
},
{
"id": 84,
"name": "ellipsis",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
},
"defaultValue": "'...'"
}
],
"type": {
"type": "intrinsic",
"name": "string"
},
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"implementationOf": {
"type": "reference",
"target": -1,
"name": "PipeTransform.transform"
}
}
],
"groups": [
{
"title": "Constructors",
"children": [
78
]
},
{
"title": "Methods",
"children": [
80
]
}
],
"sources": [
{
"fileName": "truncate.pipe.ts",
"line": 10,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/pipes/src/lib/truncate.pipe.ts#L10"
}
],
"implementedTypes": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "PipeTransform"
},
"name": "PipeTransform",
"package": "@angular/core"
}
]
}
],
"groups": [
{
"title": "Classes",
"children": [
13,
16,
23,
30,
37,
44,
52,
1,
60,
69,
77
]
}
],
"packageName": "@rxap/pipes",
"packageVersion": "19.1.3",
"readme": [
{
"kind": "text",
"text": "Provides a set of Angular pipes for common data transformations, including currency formatting, string manipulation, and object property access. These pipes offer standalone functionality for easy integration into Angular templates. The package includes pipes for escaping quotation marks, joining arrays, limiting array length, replacing substrings, slicing arrays, truncating strings, and deleting identifier properties from objects.\n\n[](https://www.npmjs.com/package/@rxap/pipes)\n[](https://commitizen.github.io/cz-cli/)\n[](https://github.com/prettier/prettier)\n\n\n\n\n- [Installation](#installation)\n- [Generators](#generators)\n - [init](#init)\n\n# Installation\n\n**Add the package to your workspace:**\n"
},
{
"kind": "code",
"text": "```bash\nyarn add @rxap/pipes\n```"
},
{
"kind": "text",
"text": "\n**Install peer dependencies:**\n"
},
{
"kind": "code",
"text": "```bash\nyarn add @angular/common @angular/core @angular/platform-browser @rxap/utilities \n```"
},
{
"kind": "text",
"text": "\n**Execute the init generator:**\n"
},
{
"kind": "code",
"text": "```bash\nyarn nx g @rxap/pipes:init\n```"
},
{
"kind": "text",
"text": "\n# Generators\n\n## init\n> Initialize the package in the workspace\n\n"
},
{
"kind": "code",
"text": "```bash\nnx g @rxap/pipes:init\n```"
}
],
"symbolIdMap": {
"0": {
"sourceFileName": "packages/angular/pipes/src/index.ts",
"qualifiedName": ""
},
"1": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "RxapCurrencyPipe"
},
"2": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "RxapCurrencyPipe.__constructor"
},
"3": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "RxapCurrencyPipe"
},
"4": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "currency"
},
"6": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "RxapCurrencyPipe.transform"
},
"7": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "RxapCurrencyPipe.transform"
},
"8": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "value"
},
"9": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "currencyCode"
},
"10": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "display"
},
"11": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "digitsInfo"
},
"12": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "locale"
},
"13": {
"sourceFileName": "packages/angular/pipes/src/lib/currency.pipe.ts",
"qualifiedName": "CurrencyPipeModule"
},
"16": {
"sourceFileName": "packages/angular/pipes/src/lib/delete-identifier.pipe.ts",
"qualifiedName": "DeleteIdentifierPipe"
},
"19": {
"sourceFileName": "packages/angular/pipes/src/lib/delete-identifier.pipe.ts",
"qualifiedName": "DeleteIdentifierPipe.transform"
},
"20": {
"sourceFileName": "packages/angular/pipes/src/lib/delete-identifier.pipe.ts",
"qualifiedName": "DeleteIdentifierPipe.transform"
},
"21": {
"sourceFileName": "packages/angular/pipes/src/lib/delete-identifier.pipe.ts",
"qualifiedName": "T"
},
"22": {
"sourceFileName": "packages/angular/pipes/src/lib/delete-identifier.pipe.ts",
"qualifiedName": "value"
},
"23": {
"sourceFileName": "packages/angular/pipes/src/lib/escape-quotation-mark.pipe.ts",
"qualifiedName": "EscapeQuotationMarkPipe"
},
"26": {
"sourceFileName": "packages/angular/pipes/src/lib/escape-quotation-mark.pipe.ts",
"qualifiedName": "EscapeQuotationMarkPipe.transform"
},
"27": {
"sourceFileName": "packages/angular/pipes/src/lib/escape-quotation-mark.pipe.ts",
"qualifiedName": "EscapeQuotationMarkPipe.transform"
},
"28": {
"sourceFileName": "packages/angular/pipes/src/lib/escape-quotation-mark.pipe.ts",
"qualifiedName": "value"
},
"29": {
"sourceFileName": "packages/angular/pipes/src/lib/escape-quotation-mark.pipe.ts",
"qualifiedName": "reverse"
},
"30": {
"sourceFileName": "packages/angular/pipes/src/lib/get-from-object.pipe.ts",
"qualifiedName": "GetFromObjectPipe"
},
"33": {
"sourceFileName": "packages/angular/pipes/src/lib/get-from-object.pipe.ts",
"qualifiedName": "GetFromObjectPipe.transform"
},
"34": {
"sourceFileName": "packages/angular/pipes/src/lib/get-from-object.pipe.ts",
"qualifiedName": "GetFromObjectPipe.transform"
},
"35": {
"sourceFileName": "packages/angular/pipes/src/lib/get-from-object.pipe.ts",
"qualifiedName": "value"
},
"36": {
"sourceFileName": "packages/angular/pipes/src/lib/get-from-object.pipe.ts",
"qualifiedName": "path"
},
"37": {
"sourceFileName": "packages/angular/pipes/src/lib/join.pipe.ts",
"qualifiedName": "JoinPipe"
},
"40": {
"sourceFileName": "packages/angular/pipes/src/lib/join.pipe.ts",
"qualifiedName": "JoinPipe.transform"
},
"41": {
"sourceFileName": "packages/angular/pipes/src/lib/join.pipe.ts",
"qualifiedName": "JoinPipe.transform"
},
"42": {
"sourceFileName": "packages/angular/pipes/src/lib/join.pipe.ts",
"qualifiedName": "list"
},
"43": {
"sourceFileName": "packages/angular/pipes/src/lib/join.pipe.ts",
"qualifiedName": "separator"
},
"44": {
"sourceFileName": "packages/angular/pipes/src/lib/limit.pipe.ts",
"qualifiedName": "LimitPipe"
},
"47": {
"sourceFileName": "packages/angular/pipes/src/lib/limit.pipe.ts",
"qualifiedName": "LimitPipe.transform"
},
"48": {
"sourceFileName": "packages/angular/pipes/src/lib/limit.pipe.ts",
"qualifiedName": "LimitPipe.transform"
},
"49": {
"sourceFileName": "packages/angular/pipes/src/lib/limit.pipe.ts",
"qualifiedName": "T"
},
"50": {
"sourceFileName": "packages/angular/pipes/src/lib/limit.pipe.ts",
"qualifiedName": "value"
},
"51": {
"sourceFileName": "packages/angular/pipes/src/lib/limit.pipe.ts",
"qualifiedName": "limit"
},
"52": {
"sourceFileName": "packages/angular/pipes/src/lib/replace.pipe.ts",
"qualifiedName": "ReplacePipe"
},
"55": {
"sourceFileName": "packages/angular/pipes/src/lib/replace.pipe.ts",
"qualifiedName": "ReplacePipe.transform"
},
"56": {
"sourceFileName": "packages/angular/pipes/src/lib/replace.pipe.ts",
"qualifiedName": "ReplacePipe.transform"
},
"57": {
"sourceFileName": "packages/angular/pipes/src/lib/replace.pipe.ts",
"qualifiedName": "value"
},
"58": {
"sourceFileName": "packages/angular/pipes/src/lib/replace.pipe.ts",
"qualifiedName": "replace"
},
"59": {
"sourceFileName": "packages/angular/pipes/src/lib/replace.pipe.ts",
"qualifiedName": "replaceValue"
},
"60": {
"sourceFileName": "packages/angular/pipes/src/lib/slice.pipe.ts",
"qualifiedName": "SlicePipe"
},
"63": {
"sourceFileName": "packages/angular/pipes/src/lib/slice.pipe.ts",
"qualifiedName": "SlicePipe.transform"
},
"64": {
"sourceFileName": "packages/angular/pipes/src/lib/slice.pipe.ts",
"qualifiedName": "SlicePipe.transform"
},
"65": {
"sourceFileName": "packages/angular/pipes/src/lib/slice.pipe.ts",
"