UNPKG

1.34 kBJSONView Raw
1{
2 "$schema": "http://json-schema.org/schema",
3 "$id": "ng-cli://commands/doc.json",
4 "description": "Opens the official Angular documentation (angular.io) in a browser, and searches for a given keyword.",
5 "$longDescription": "",
6
7 "$aliases": [ "d" ],
8 "$type": "native",
9 "$impl": "./doc-impl#DocCommand",
10
11 "type": "object",
12 "allOf": [
13 {
14 "properties": {
15 "keyword": {
16 "type": "string",
17 "description": "The keyword to search for, as provided in the search bar in angular.io.",
18 "$default": {
19 "$source": "argv",
20 "index": 0
21 }
22 },
23 "search": {
24 "aliases": ["s"],
25 "type": "boolean",
26 "default": false,
27 "description": "When true, searches all of angular.io. Otherwise, searches only API reference documentation."
28 },
29 "version" : {
30 "oneOf": [
31 {
32 "type": "number",
33 "minimum": 4
34 },
35 {
36 "enum": [2, "next"]
37 }
38 ],
39 "description": "Contains the version of Angular to use for the documentation. If not provided, the command uses your current Angular core version."
40 }
41 },
42 "required": [
43 ]
44 },
45 { "$ref": "./definitions.json#/definitions/base" }
46 ]
47}