@rxap/life-cycle
Version:
Provides an Angular service and guard to manage application lifecycle. It allows to execute code when the application is stable and ready. Includes a guard to prevent route activation until the app is ready.
905 lines (904 loc) • 25.2 kB
JSON
{
"id": 0,
"name": "@rxap/life-cycle",
"variant": "project",
"kind": 1,
"flags": {},
"children": [
{
"id": 1,
"name": "IsAppReadyGuard",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 2,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "is-app-ready.guard.ts",
"line": 14,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/is-app-ready.guard.ts#L14"
}
],
"signatures": [
{
"id": 3,
"name": "IsAppReadyGuard",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "is-app-ready.guard.ts",
"line": 14,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/is-app-ready.guard.ts#L14"
}
],
"parameters": [
{
"id": 4,
"name": "lifecycle",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": 12,
"name": "LifeCycleService",
"package": "@rxap/life-cycle"
}
}
],
"type": {
"type": "reference",
"target": 1,
"name": "IsAppReadyGuard",
"package": "@rxap/life-cycle"
}
}
]
},
{
"id": 6,
"name": "canActivate",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "is-app-ready.guard.ts",
"line": 17,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/is-app-ready.guard.ts#L17"
}
],
"signatures": [
{
"id": 7,
"name": "canActivate",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "is-app-ready.guard.ts",
"line": 17,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/is-app-ready.guard.ts#L17"
}
],
"parameters": [
{
"id": 8,
"name": "next",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/router/index.d.ts",
"qualifiedName": "ActivatedRouteSnapshot"
},
"name": "ActivatedRouteSnapshot",
"package": "@angular/router"
}
},
{
"id": 9,
"name": "state",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/router/index.d.ts",
"qualifiedName": "RouterStateSnapshot"
},
"name": "RouterStateSnapshot",
"package": "@angular/router"
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/rxjs/src/internal/Observable.ts",
"qualifiedName": "Observable"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "boolean"
}
],
"name": "Observable",
"package": "rxjs"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [
2
]
},
{
"title": "Methods",
"children": [
6
]
}
],
"sources": [
{
"fileName": "is-app-ready.guard.ts",
"line": 12,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/is-app-ready.guard.ts#L12"
}
]
},
{
"id": 12,
"name": "LifeCycleService",
"variant": "declaration",
"kind": 128,
"flags": {},
"children": [
{
"id": 18,
"name": "constructor",
"variant": "declaration",
"kind": 512,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 33,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L33"
}
],
"signatures": [
{
"id": 19,
"name": "LifeCycleService",
"variant": "signature",
"kind": 16384,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 33,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L33"
}
],
"parameters": [
{
"id": 20,
"name": "appRef",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "ApplicationRef"
},
"name": "ApplicationRef",
"package": "@angular/core"
}
}
],
"type": {
"type": "reference",
"target": 12,
"name": "LifeCycleService",
"package": "@rxap/life-cycle"
}
}
]
},
{
"id": 22,
"name": "appRef",
"variant": "declaration",
"kind": 1024,
"flags": {
"isPublic": true,
"isReadonly": true
},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 33,
"character": 54,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L33"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/@angular/core/index.d.ts",
"qualifiedName": "ApplicationRef"
},
"name": "ApplicationRef",
"package": "@angular/core"
}
},
{
"id": 21,
"name": "isReady$",
"variant": "declaration",
"kind": 1024,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 31,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L31"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/rxjs/src/internal/BehaviorSubject.ts",
"qualifiedName": "BehaviorSubject"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "boolean"
}
],
"name": "BehaviorSubject",
"package": "rxjs"
},
"defaultValue": "..."
},
{
"id": 23,
"name": "whenReady",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true
},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 51,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L51"
}
],
"signatures": [
{
"id": 24,
"name": "whenReady",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 51,
"character": 9,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L51"
}
],
"typeParameters": [
{
"id": 25,
"name": "T",
"variant": "typeParam",
"kind": 131072,
"flags": {}
}
],
"parameters": [
{
"id": 26,
"name": "thenOrFunction",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "union",
"types": [
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/rxjs/src/internal/Observable.ts",
"qualifiedName": "Observable"
},
"typeArguments": [
{
"type": "reference",
"target": 25,
"name": "T",
"package": "@rxap/life-cycle",
"refersToTypeParameter": true
}
],
"name": "Observable",
"package": "rxjs"
},
{
"type": "reference",
"target": {
"sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "PromiseLike"
},
"typeArguments": [
{
"type": "reference",
"target": 25,
"name": "T",
"package": "@rxap/life-cycle",
"refersToTypeParameter": true
}
],
"name": "PromiseLike",
"package": "typescript"
},
{
"type": "reflection",
"declaration": {
"id": 27,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 51,
"character": 72,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L51"
}
],
"signatures": [
{
"id": 28,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 51,
"character": 72,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L51"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/rxjs/src/internal/Observable.ts",
"qualifiedName": "Observable"
},
"typeArguments": [
{
"type": "reference",
"target": 25,
"name": "T",
"package": "@rxap/life-cycle",
"refersToTypeParameter": true
}
],
"name": "Observable",
"package": "rxjs"
}
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 29,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 51,
"character": 96,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L51"
}
],
"signatures": [
{
"id": 30,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 51,
"character": 96,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L51"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "PromiseLike"
},
"typeArguments": [
{
"type": "reference",
"target": 25,
"name": "T",
"package": "@rxap/life-cycle",
"refersToTypeParameter": true
}
],
"name": "PromiseLike",
"package": "typescript"
}
}
]
}
},
{
"type": "reflection",
"declaration": {
"id": 31,
"name": "__type",
"variant": "declaration",
"kind": 65536,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 51,
"character": 121,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L51"
}
],
"signatures": [
{
"id": 32,
"name": "__type",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 51,
"character": 121,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L51"
}
],
"type": {
"type": "reference",
"target": 25,
"name": "T",
"package": "@rxap/life-cycle",
"refersToTypeParameter": true
}
}
]
}
}
]
}
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/rxjs/src/internal/Observable.ts",
"qualifiedName": "Observable"
},
"typeArguments": [
{
"type": "reference",
"target": 25,
"name": "T",
"package": "@rxap/life-cycle",
"refersToTypeParameter": true
}
],
"name": "Observable",
"package": "rxjs"
}
}
]
},
{
"id": 14,
"name": "AddHook",
"variant": "declaration",
"kind": 2048,
"flags": {
"isPublic": true,
"isStatic": true
},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 47,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L47"
}
],
"signatures": [
{
"id": 15,
"name": "AddHook",
"variant": "signature",
"kind": 4096,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 47,
"character": 16,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L47"
}
],
"parameters": [
{
"id": 16,
"name": "name",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "intrinsic",
"name": "string"
}
},
{
"id": 17,
"name": "promise",
"variant": "param",
"kind": 32768,
"flags": {},
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "PromiseLike"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "PromiseLike",
"package": "typescript"
}
}
],
"type": {
"type": "intrinsic",
"name": "void"
}
}
]
}
],
"groups": [
{
"title": "Constructors",
"children": [
18
]
},
{
"title": "Properties",
"children": [
22,
21
]
},
{
"title": "Methods",
"children": [
23,
14
]
}
],
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 28,
"character": 13,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L28"
}
]
},
{
"id": 10,
"name": "LifeCycleHook",
"variant": "declaration",
"kind": 256,
"flags": {},
"children": [
{
"id": 11,
"name": "promise",
"variant": "declaration",
"kind": 1024,
"flags": {},
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 22,
"character": 2,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L22"
}
],
"type": {
"type": "reference",
"target": {
"sourceFileName": "node_modules/typescript/lib/lib.es5.d.ts",
"qualifiedName": "PromiseLike"
},
"typeArguments": [
{
"type": "intrinsic",
"name": "any"
}
],
"name": "PromiseLike",
"package": "typescript"
}
}
],
"groups": [
{
"title": "Properties",
"children": [
11
]
}
],
"sources": [
{
"fileName": "life-cycle.service.ts",
"line": 21,
"character": 17,
"url": "https://gitlab.com/rxap/packages/-/blob/15b5fab8912b1042ea325e7f4d98844416018df1/packages/angular/life-cycle/src/lib/life-cycle.service.ts#L21"
}
]
}
],
"groups": [
{
"title": "Classes",
"children": [
1,
12
]
},
{
"title": "Interfaces",
"children": [
10
]
}
],
"packageName": "@rxap/life-cycle",
"packageVersion": "19.0.3",
"readme": [
{
"kind": "text",
"text": "Provides an Angular service and guard to manage application lifecycle. It allows to execute code when the application is stable and ready. Includes a guard to prevent route activation until the app is ready.\n\n[](https://www.npmjs.com/package/@rxap/life-cycle)\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/life-cycle\n```"
},
{
"kind": "text",
"text": "\n**Install peer dependencies:**\n"
},
{
"kind": "code",
"text": "```bash\nyarn add @angular/core @angular/router @rxap/utilities rxjs \n```"
},
{
"kind": "text",
"text": "\n**Execute the init generator:**\n"
},
{
"kind": "code",
"text": "```bash\nyarn nx g @rxap/life-cycle: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/life-cycle:init\n```"
}
],
"symbolIdMap": {
"0": {
"sourceFileName": "packages/angular/life-cycle/src/index.ts",
"qualifiedName": ""
},
"1": {
"sourceFileName": "packages/angular/life-cycle/src/lib/is-app-ready.guard.ts",
"qualifiedName": "IsAppReadyGuard"
},
"2": {
"sourceFileName": "packages/angular/life-cycle/src/lib/is-app-ready.guard.ts",
"qualifiedName": "IsAppReadyGuard.__constructor"
},
"3": {
"sourceFileName": "packages/angular/life-cycle/src/lib/is-app-ready.guard.ts",
"qualifiedName": "IsAppReadyGuard"
},
"4": {
"sourceFileName": "packages/angular/life-cycle/src/lib/is-app-ready.guard.ts",
"qualifiedName": "lifecycle"
},
"6": {
"sourceFileName": "packages/angular/life-cycle/src/lib/is-app-ready.guard.ts",
"qualifiedName": "IsAppReadyGuard.canActivate"
},
"7": {
"sourceFileName": "packages/angular/life-cycle/src/lib/is-app-ready.guard.ts",
"qualifiedName": "IsAppReadyGuard.canActivate"
},
"8": {
"sourceFileName": "packages/angular/life-cycle/src/lib/is-app-ready.guard.ts",
"qualifiedName": "next"
},
"9": {
"sourceFileName": "packages/angular/life-cycle/src/lib/is-app-ready.guard.ts",
"qualifiedName": "state"
},
"10": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleHook"
},
"11": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleHook.promise"
},
"12": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService"
},
"14": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService.AddHook"
},
"15": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService.AddHook"
},
"16": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "name"
},
"17": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "promise"
},
"18": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService.__constructor"
},
"19": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService"
},
"20": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "appRef"
},
"21": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService.isReady$"
},
"22": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService.appRef"
},
"23": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService.whenReady"
},
"24": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "LifeCycleService.whenReady"
},
"25": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "T"
},
"26": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "thenOrFunction"
},
"27": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "__type"
},
"28": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "__type"
},
"29": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "__type"
},
"30": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "__type"
},
"31": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "__type"
},
"32": {
"sourceFileName": "packages/angular/life-cycle/src/lib/life-cycle.service.ts",
"qualifiedName": "__type"
}
},
"files": {
"entries": {
"1": "packages/angular/life-cycle/src/index.ts"
},
"reflections": {
"1": 0
}
}
}