3
3
< head >
4
4
< meta charset ="utf-8 ">
5
5
< meta http-equiv ="X-UA-Compatible " content ="IE=edge ">
6
- < title > @map-colonies/ts-npm-package-boilerplate </ title >
7
- < meta name ="description " content ="Documentation for @map-colonies/ts-npm-package-boilerplate ">
6
+ < title > @map-colonies/read-pkg </ title >
7
+ < meta name ="description " content ="Documentation for @map-colonies/read-pkg ">
8
8
< meta name ="viewport " content ="width=device-width, initial-scale=1 ">
9
9
< link rel ="stylesheet " href ="assets/css/main.css ">
10
10
< script async src ="assets/js/search.js " id ="search-script "> </ script >
23
23
< li class ="state loading "> Preparing search index...</ li >
24
24
< li class ="state failure "> The search index is not available</ li >
25
25
</ ul >
26
- < a href ="index.html " class ="title "> @map-colonies/ts-npm-package-boilerplate </ a >
26
+ < a href ="index.html " class ="title "> @map-colonies/read-pkg </ a >
27
27
</ div >
28
28
< div class ="table-cell " id ="tsd-widgets ">
29
29
< div id ="tsd-filter ">
50
50
</ div >
51
51
< div class ="tsd-page-title ">
52
52
< div class ="container ">
53
- < h1 > @map-colonies/ts-npm-package-boilerplate </ h1 >
53
+ < h1 > @map-colonies/read-pkg </ h1 >
54
54
</ div >
55
55
</ div >
56
56
</ header >
@@ -62,33 +62,41 @@ <h2>Index</h2>
62
62
< section class ="tsd-panel tsd-index-panel ">
63
63
< div class ="tsd-index-content ">
64
64
< section class ="tsd-index-section ">
65
- < h3 > Variables </ h3 >
65
+ < h3 > Functions </ h3 >
66
66
< ul class ="tsd-index-list ">
67
- < li class ="tsd-kind-variable "> < a href ="modules.html#cat " class ="tsd-kind-icon "> cat </ a > </ li >
67
+ < li class ="tsd-kind-function "> < a href ="modules.html#readpackagejsonsync " class ="tsd-kind-icon "> read < wbr > Package < wbr > Json < wbr > Sync </ a > </ li >
68
68
</ ul >
69
69
</ section >
70
70
</ div >
71
71
</ section >
72
72
</ section >
73
73
< section class ="tsd-panel-group tsd-member-group ">
74
- < h2 > Variables</ h2 >
75
- < section class ="tsd-panel tsd-member tsd-kind-variable ">
76
- < a name ="cat " class ="tsd-anchor "> </ a >
77
- < h3 > < span class ="tsd-flag ts-flagConst "> Const</ span > cat</ h3 >
78
- < div class ="tsd-signature tsd-kind-icon "> cat< span class ="tsd-signature-symbol "> :</ span > < span class ="tsd-signature-symbol "> { </ span > say< span class ="tsd-signature-symbol "> : </ span > < span class ="tsd-signature-type "> string</ span > < span class ="tsd-signature-symbol "> }</ span > < span class ="tsd-signature-symbol "> = ...</ span > </ div >
79
- < aside class ="tsd-sources ">
80
- < ul >
81
- < li > Defined in < a href ="https://github.com/MapColonies/ts-npm-package-boilerplate/blob/94a0247/src/index.ts#L1 "> index.ts:1</ a > </ li >
82
- </ ul >
83
- </ aside >
84
- < div class ="tsd-type-declaration ">
85
- < h4 > Type declaration</ h4 >
86
- < ul class ="tsd-parameters ">
87
- < li class ="tsd-parameter ">
88
- < h5 > say< span class ="tsd-signature-symbol "> : </ span > < span class ="tsd-signature-type "> string</ span > </ h5 >
89
- </ li >
90
- </ ul >
91
- </ div >
74
+ < h2 > Functions</ h2 >
75
+ < section class ="tsd-panel tsd-member tsd-kind-function ">
76
+ < a name ="readpackagejsonsync " class ="tsd-anchor "> </ a >
77
+ < h3 > read< wbr > Package< wbr > Json< wbr > Sync</ h3 >
78
+ < ul class ="tsd-signatures tsd-kind-function ">
79
+ < li class ="tsd-signature tsd-kind-icon "> read< wbr > Package< wbr > Json< wbr > Sync< span class ="tsd-signature-symbol "> (</ span > path< span class ="tsd-signature-symbol "> ?: </ span > < span class ="tsd-signature-type "> string</ span > , encoding< span class ="tsd-signature-symbol "> ?: </ span > < span class ="tsd-signature-type "> BufferEncoding</ span > < span class ="tsd-signature-symbol "> )</ span > < span class ="tsd-signature-symbol "> : </ span > < span class ="tsd-signature-type "> PackageJson</ span > </ li >
80
+ </ ul >
81
+ < ul class ="tsd-descriptions ">
82
+ < li class ="tsd-description ">
83
+ < aside class ="tsd-sources ">
84
+ < ul >
85
+ < li > Defined in < a href ="https://github.com/MapColonies/read-pkg/blob/cca742f/src/index.ts#L5 "> index.ts:5</ a > </ li >
86
+ </ ul >
87
+ </ aside >
88
+ < h4 class ="tsd-parameters-title "> Parameters</ h4 >
89
+ < ul class ="tsd-parameters ">
90
+ < li >
91
+ < h5 > path: < span class ="tsd-signature-type "> string</ span > < span class ="tsd-signature-symbol "> = './package.json'</ span > </ h5 >
92
+ </ li >
93
+ < li >
94
+ < h5 > encoding: < span class ="tsd-signature-type "> BufferEncoding</ span > < span class ="tsd-signature-symbol "> = 'utf-8'</ span > </ h5 >
95
+ </ li >
96
+ </ ul >
97
+ < h4 class ="tsd-returns-title "> Returns < span class ="tsd-signature-type "> PackageJson</ span > </ h4 >
98
+ </ li >
99
+ </ ul >
92
100
</ section >
93
101
</ section >
94
102
</ div >
@@ -102,8 +110,8 @@ <h5>say<span class="tsd-signature-symbol">: </span><span class="tsd-signature-ty
102
110
</ nav >
103
111
< nav class ="tsd-navigation secondary menu-sticky ">
104
112
< ul class ="before-current ">
105
- < li class =" tsd-kind-variable ">
106
- < a href ="modules.html#cat " class ="tsd-kind-icon "> cat </ a >
113
+ < li class =" tsd-kind-function ">
114
+ < a href ="modules.html#readpackagejsonsync " class ="tsd-kind-icon "> read < wbr > Package < wbr > Json < wbr > Sync </ a >
107
115
</ li >
108
116
</ ul >
109
117
</ nav >
0 commit comments