Skip to content

Commit 7c85d08

Browse files
JamesKyburzJamesKyburz
committed
fix(parse): types
1 parent 2a9c95a commit 7c85d08

4 files changed

Lines changed: 17 additions & 14 deletions

File tree

‎index.d.ts‎

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,8 +2,8 @@ declare module '@starterstack/sam-expand/parse' {
22
export function template(templatePath: string): Promise<any>;
33

44
export function samConfig(configPath: string): Promise<any>;
5-
65
export function parse(data: string, type: 'toml' | 'yaml'): any;
6+
export type Parse = (data: string, type: 'toml' | 'yaml') => any;
77
}
88

99
declare module '@starterstack/sam-expand/log' {
@@ -34,7 +34,7 @@ declare module '@starterstack/sam-expand/resolve' {
3434
command: string;
3535
argv: string[];
3636
argvReader: ArgvReader;
37-
parse: typeof parse.parse;
37+
parse: Parse;
3838
dump: typeof yamlDump;
3939
spawn: Spawn;
4040
configEnv: string;
@@ -46,6 +46,7 @@ declare module '@starterstack/sam-expand/resolve' {
4646
type ArgvReader_1 = (name: string, options?: {
4747
parameter: boolean;
4848
}) => string | undefined;
49+
type Parse = (data: string, type: 'toml' | 'yaml') => any;
4950
type Spawn = (cmd: string, args: string[], options?: import('node:child_process').SpawnOptions) => Promise<void | string>;
5051
}
5152

@@ -66,7 +67,7 @@ declare module '@starterstack/sam-expand/plugins' {
6667
command: string;
6768
argv: string[];
6869
argvReader: ArgvReader;
69-
parse: typeof parse.parse;
70+
parse: Parse;
7071
dump: typeof yamlDump;
7172
spawn: Spawn;
7273
configEnv: string;
@@ -80,6 +81,7 @@ declare module '@starterstack/sam-expand/plugins' {
8081
type ArgvReader_1 = (name: string, options?: {
8182
parameter: boolean;
8283
}) => string | undefined;
84+
type Parse = (data: string, type: 'toml' | 'yaml') => any;
8385
type Spawn = (cmd: string, args: string[], options?: import('node:child_process').SpawnOptions) => Promise<void | string>;
8486
}
8587

@@ -115,7 +117,7 @@ declare module '@starterstack/sam-expand/plugins/parameter-overrides' {
115117
command: string;
116118
argv: string[];
117119
argvReader: ArgvReader;
118-
parse: typeof parse.parse;
120+
parse: Parse;
119121
dump: typeof yamlDump;
120122
spawn: Spawn;
121123
configEnv: string;
@@ -129,6 +131,7 @@ declare module '@starterstack/sam-expand/plugins/parameter-overrides' {
129131
type ArgvReader_1 = (name: string, options?: {
130132
parameter: boolean;
131133
}) => string | undefined;
134+
type Parse = (data: string, type: 'toml' | 'yaml') => any;
132135
type Spawn = (cmd: string, args: string[], options?: import('node:child_process').SpawnOptions) => Promise<void | string>;
133136
}
134137

@@ -173,7 +176,7 @@ declare module '@starterstack/sam-expand/plugins/run-script-hooks' {
173176
command: string;
174177
argv: string[];
175178
argvReader: ArgvReader;
176-
parse: typeof parse.parse;
179+
parse: Parse;
177180
dump: typeof yamlDump;
178181
spawn: Spawn;
179182
configEnv: string;
@@ -187,6 +190,7 @@ declare module '@starterstack/sam-expand/plugins/run-script-hooks' {
187190
type ArgvReader_1 = (name: string, options?: {
188191
parameter: boolean;
189192
}) => string | undefined;
193+
type Parse = (data: string, type: 'toml' | 'yaml') => any;
190194
type Spawn = (cmd: string, args: string[], options?: import('node:child_process').SpawnOptions) => Promise<void | string>;
191195
}
192196

@@ -214,7 +218,7 @@ declare module '@starterstack/sam-expand/plugins/esbuild-node' {
214218
command: string;
215219
argv: string[];
216220
argvReader: ArgvReader;
217-
parse: typeof parse.parse;
221+
parse: Parse;
218222
dump: typeof yamlDump;
219223
spawn: Spawn;
220224
configEnv: string;
@@ -228,6 +232,7 @@ declare module '@starterstack/sam-expand/plugins/esbuild-node' {
228232
type ArgvReader_1 = (name: string, options?: {
229233
parameter: boolean;
230234
}) => string | undefined;
235+
type Parse = (data: string, type: 'toml' | 'yaml') => any;
231236
type Spawn = (cmd: string, args: string[], options?: import('node:child_process').SpawnOptions) => Promise<void | string>;
232237
}
233238

‎index.d.ts.map‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
"template",
66
"samConfig",
77
"parse",
8+
"Parse",
89
"Log",
910
"Spawn",
1011
"resolveFile",
@@ -48,5 +49,5 @@
4849
null,
4950
null
5051
],
51-
"mappings": ";iBAGgBA,QAAQA;;iBAIRC,SAASA;;iBAMTC,KAAKA;;;;;aCZTC,GAAGA;;;;;aCAHC,KAAKA;;;;;iBCWDC,WAAWA;;;;;aAKfC,YAAYA;MCeZC,SAASA;MC1BTC,UAAUA;MDuCVC,aAAaA;;;;;;;;;;;;;;;;MH5CbN,GAAGA;;;;MCAHC,KAAKA;;;;;aE4DLM,MAAMA;aAhBND,aAAaA;aAiBbE,YAAYA;aApBZC,UAAUA;MAVVL,SAASA;;MC1BTC,UAAUA;;;;;;;;;;;;;;;;;;;MJLVL,GAAGA;;;;MCAHC,KAAKA;;;;;cIAJS,UAAUA;;;cAQVC,MAAMA;cACNC,cAAcA;;cAEdC,SAASA;aACVC,QAAQA;;;;;aAKRC,MAAMA;;;;MF2CNR,MAAMA;MACNC,YAAYA;MApBZC,UAAUA;MAVVL,SAASA;;MC1BTC,UAAUA;MDuCVC,aAAaA;;;;;;;;;;;;;;;;;;MH5CbN,GAAGA;;;;MCAHC,KAAKA;;;;;cKDJW,cAAcA;;cAEdF,UAAUA;;cAEVC,MAAMA;;cAENE,SAASA;aACVG,IAAIA;aACJC,IAAIA;;;;;aAKJC,OAAOA;;;;;;;aAOPC,UAAUA;;;;;MHyCVZ,MAAMA;MACNC,YAAYA;MApBZC,UAAUA;MAVVL,SAASA;;MC1BTC,UAAUA;MDuCVC,aAAaA;;;;;;;;;;;;;;;;;;MH5CbN,GAAGA;;;;MCAHC,KAAKA;;;;;cMAJS,UAAUA;;cAEVC,MAAMA;;;cAGNC,cAAcA;;cAEdC,SAASA;MJqDVN,MAAMA;MACNC,YAAYA;MApBZC,UAAUA;MAVVL,SAASA;;MC1BTC,UAAUA;MDuCVC,aAAaA;;;;;;;;;;;;;;;;;;MH5CbN,GAAGA;;;;MCAHC,KAAKA"
52+
"mappings": ";iBAGgBA,QAAQA;;iBAIRC,SAASA;iBACTC,KAAKA;aACTC,KAAKA;;;;;aCRLC,GAAGA;;;;;aCAHC,KAAKA;;;;;iBCWDC,WAAWA;;;;;aAKfC,YAAYA;MCeZC,SAASA;MC1BTC,UAAUA;MDuCVC,aAAaA;;;;;;;;;;;;;;;;MH5CbN,GAAGA;;;;MDQHD,KAAKA;MERLE,KAAKA;;;;;aE4DLM,MAAMA;aAhBND,aAAaA;aAiBbE,YAAYA;aApBZC,UAAUA;MAVVL,SAASA;;MC1BTC,UAAUA;;;;;;;;;;;;;;;;;;;MJLVL,GAAGA;;;;MDQHD,KAAKA;MERLE,KAAKA;;;;;cIAJS,UAAUA;;;cAQVC,MAAMA;cACNC,cAAcA;;cAEdC,SAASA;aACVC,QAAQA;;;;;aAKRC,MAAMA;;;;MF2CNR,MAAMA;MACNC,YAAYA;MApBZC,UAAUA;MAVVL,SAASA;;MC1BTC,UAAUA;MDuCVC,aAAaA;;;;;;;;;;;;;;;;;;MH5CbN,GAAGA;;;;MDQHD,KAAKA;MERLE,KAAKA;;;;;cKDJW,cAAcA;;cAEdF,UAAUA;;cAEVC,MAAMA;;cAENE,SAASA;aACVG,IAAIA;aACJC,IAAIA;;;;;aAKJC,OAAOA;;;;;;;aAOPC,UAAUA;;;;;MHyCVZ,MAAMA;MACNC,YAAYA;MApBZC,UAAUA;MAVVL,SAASA;;MC1BTC,UAAUA;MDuCVC,aAAaA;;;;;;;;;;;;;;;;;;MH5CbN,GAAGA;;;;MDQHD,KAAKA;MERLE,KAAKA;;;;;cMAJS,UAAUA;;cAEVC,MAAMA;;;cAGNC,cAAcA;;cAEdC,SAASA;MJqDVN,MAAMA;MACNC,YAAYA;MApBZC,UAAUA;MAVVL,SAASA;;MC1BTC,UAAUA;MDuCVC,aAAaA;;;;;;;;;;;;;;;;;;MH5CbN,GAAGA;;;;MDQHD,KAAKA;MERLE,KAAKA"
5253
}

‎src/expand.js‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ if (windows && !/bash/.test(String(process.env['SHELL']))) {
7171
* command: string,
7272
* argv: string[],
7373
* argvReader: ArgvReader,
74-
* parse: import('./parse.js').parse,
74+
* parse: import('./parse.js').Parse,
7575
* dump: import('yaml-cfn').yamlDump,
7676
* spawn: import('./spawn.js').Spawn,
7777
* configEnv: string,

‎src/parse.js‎

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
//@ts-check
22

33
/**
4+
* @typedef {(data: string, type: 'toml' | 'yaml') => any} Parse
5+
*
46
* @summary
57
* Parse [SAM template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html) yaml/json files, and [SAM config](https://docs.aws.amazon.com/serverless-application-model/latest/developerguide/serverless-sam-cli-config.html) yaml/toml files.
68
*
@@ -39,12 +41,7 @@ export async function samConfig(configPath) {
3941
}
4042
}
4143

42-
/**
43-
* @param { string } data
44-
* @param { 'toml' | 'yaml' } type
45-
* @returns {any}
46-
**/
47-
44+
/** @type {Parse} */
4845
export function parse(data, type) {
4946
return type === 'toml' ? freeze(tomlParse(data)) : freeze(yamlParse(data))
5047
}

0 commit comments

Comments
 (0)