Skip to content

Commit

Permalink
fix: typedoc upgrade
Browse files Browse the repository at this point in the history
  • Loading branch information
JamesKyburz committed Sep 22, 2024
1 parent 1dc8d69 commit 302b596
Show file tree
Hide file tree
Showing 13 changed files with 51 additions and 14 deletions.
48 changes: 48 additions & 0 deletions index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,11 @@ declare module '@starterstack/sam-expand/parse' {

export function samConfig(configPath: string): Promise<any>;
export function parse(data: string, type: "toml" | "yaml"): any;
/**
* 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.
*
* Provides a parse method that parses yaml, json, or toml.
*/
export type Parse = (data: string, type: "toml" | "yaml") => any;

export {};
Expand All @@ -17,6 +22,9 @@ declare module '@starterstack/sam-expand/log' {

declare module '@starterstack/sam-expand/spawn' {
export default function spawn(cmd: string, args: string[], options?: import("node:child_process").SpawnOptions): Promise<void | string>;
/**
* [node:child_process](https://nodejs.org/docs/latest/api/child_process.html#child-process).spawn wrapper.
*/
export type Spawn = (cmd: string, args: string[], options?: import("node:child_process").SpawnOptions) => Promise<void | string>;

export {};
Expand Down Expand Up @@ -52,7 +60,15 @@ declare module '@starterstack/sam-expand/resolve' {
type ArgvReader_1 = (name: string, options?: {
parameter: boolean;
}) => string | undefined;
/**
* 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.
*
* Provides a parse method that parses yaml, json, or toml.
*/
type Parse = (data: string, type: "toml" | "yaml") => any;
/**
* [node:child_process](https://nodejs.org/docs/latest/api/child_process.html#child-process).spawn wrapper.
*/
type Spawn = (cmd: string, args: string[], options?: import("node:child_process").SpawnOptions) => Promise<void | string>;

export {};
Expand Down Expand Up @@ -89,7 +105,15 @@ declare module '@starterstack/sam-expand/plugins' {
type ArgvReader_1 = (name: string, options?: {
parameter: boolean;
}) => string | undefined;
/**
* 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.
*
* Provides a parse method that parses yaml, json, or toml.
*/
type Parse = (data: string, type: "toml" | "yaml") => any;
/**
* [node:child_process](https://nodejs.org/docs/latest/api/child_process.html#child-process).spawn wrapper.
*/
type Spawn = (cmd: string, args: string[], options?: import("node:child_process").SpawnOptions) => Promise<void | string>;

export {};
Expand Down Expand Up @@ -141,7 +165,15 @@ declare module '@starterstack/sam-expand/plugins/parameter-overrides' {
type ArgvReader_1 = (name: string, options?: {
parameter: boolean;
}) => string | undefined;
/**
* 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.
*
* Provides a parse method that parses yaml, json, or toml.
*/
type Parse = (data: string, type: "toml" | "yaml") => any;
/**
* [node:child_process](https://nodejs.org/docs/latest/api/child_process.html#child-process).spawn wrapper.
*/
type Spawn = (cmd: string, args: string[], options?: import("node:child_process").SpawnOptions) => Promise<void | string>;

export {};
Expand Down Expand Up @@ -200,7 +232,15 @@ declare module '@starterstack/sam-expand/plugins/run-script-hooks' {
type ArgvReader_1 = (name: string, options?: {
parameter: boolean;
}) => string | undefined;
/**
* 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.
*
* Provides a parse method that parses yaml, json, or toml.
*/
type Parse = (data: string, type: "toml" | "yaml") => any;
/**
* [node:child_process](https://nodejs.org/docs/latest/api/child_process.html#child-process).spawn wrapper.
*/
type Spawn = (cmd: string, args: string[], options?: import("node:child_process").SpawnOptions) => Promise<void | string>;

export {};
Expand Down Expand Up @@ -244,7 +284,15 @@ declare module '@starterstack/sam-expand/plugins/esbuild-node' {
type ArgvReader_1 = (name: string, options?: {
parameter: boolean;
}) => string | undefined;
/**
* 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.
*
* Provides a parse method that parses yaml, json, or toml.
*/
type Parse = (data: string, type: "toml" | "yaml") => any;
/**
* [node:child_process](https://nodejs.org/docs/latest/api/child_process.html#child-process).spawn wrapper.
*/
type Spawn = (cmd: string, args: string[], options?: import("node:child_process").SpawnOptions) => Promise<void | string>;

export {};
Expand Down
2 changes: 1 addition & 1 deletion index.d.ts.map
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,6 @@
null,
null
],
"mappings": ";iBAqBsBA,QAAQA;;iBASRC,SAASA;;aA3B4BC,KAAKA;;;;;;;aCAXC,GAAGA;;;;;;;aCAmEC,KAAKA;;;;;;;iBCuB1GC,WAAWA;;;;;;MCkC4KC,SAASA;MCzD/HC,UAAUA;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;MDAGD,KAAKA;MEA2DE,KAAKA;;;;;;;aE8ExEI,MAAMA;aEnE1BC,aAAaA;;aFgDlBC,UAAUA;MAFoKJ,SAASA;;MCzD/HC,UAAUA;;;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;MDAGD,KAAKA;MEA2DE,KAAKA;;;;;;;cKoCnHO,UAAUA;;;cAWVC,MAAMA;cAyBNC,cAAcA;;cAGdC,SAASA;aApCoDC,QAAQA;;;;;aACZC,MAAMA;;;;MHsCpBR,MAAMA;;MAnB/BE,UAAUA;MAFoKJ,SAASA;;MCzD/HC,UAAUA;;;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;MDAGD,KAAKA;MEA2DE,KAAKA;;;;;;;cMuDnHS,cAAcA;;cAGdF,UAAUA;;cAGVC,MAAMA;;cAoENE,SAASA;aAjG8IG,IAAIA;aAC1FC,IAAIA;;;;;aACHC,OAAOA;;;;;;;;;;MJ4C9BX,MAAMA;;MAnB/BE,UAAUA;MAFoKJ,SAASA;;MCzD/HC,UAAUA;;;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;MDAGD,KAAKA;MEA2DE,KAAKA;;;;;;;cO6CnHO,UAAUA;;cAGVC,MAAMA;;;cAWNC,cAAcA;;cAGdC,SAASA;MLgBkCN,MAAMA;;MAnB/BE,UAAUA;MAFoKJ,SAASA;;MCzD/HC,UAAUA;;;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;MDAGD,KAAKA;MEA2DE,KAAKA",
"mappings": ";iBAoBsBA,QAAQA;;iBASRC,SAASA;;;;;;;aA1B4BC,KAAKA;;;;;;;aCAXC,GAAGA;;;;;;;;;;aCAmEC,KAAKA;;;;;;;iBCsB1GC,WAAWA;;;;;;MCkC4KC,SAASA;MCxD/HC,UAAUA;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;;;;;;MDAGD,KAAKA;;;;MEA2DE,KAAKA;;;;;;;aE6ExEI,MAAMA;aEnE1BC,aAAaA;;aFgDlBC,UAAUA;MAFoKJ,SAASA;;MCxD/HC,UAAUA;;;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;;;;;;MDAGD,KAAKA;;;;MEA2DE,KAAKA;;;;;;;cKmCnHO,UAAUA;;;cAWVC,MAAMA;cAyBNC,cAAcA;;cAGdC,SAASA;aApCoDC,QAAQA;;;;;aACZC,MAAMA;;;;MHsCpBR,MAAMA;;MAnB/BE,UAAUA;MAFoKJ,SAASA;;MCxD/HC,UAAUA;;;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;;;;;;MDAGD,KAAKA;;;;MEA2DE,KAAKA;;;;;;;cMsDnHS,cAAcA;;cAGdF,UAAUA;;cAGVC,MAAMA;;cAoENE,SAASA;aAjG8IG,IAAIA;aAC1FC,IAAIA;;;;;aACHC,OAAOA;;;;;;;;;;MJ4C9BX,MAAMA;;MAnB/BE,UAAUA;MAFoKJ,SAASA;;MCxD/HC,UAAUA;;;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;;;;;;MDAGD,KAAKA;;;;MEA2DE,KAAKA;;;;;;;cO6CnHO,UAAUA;;cAGVC,MAAMA;;;cAWNC,cAAcA;;cAGdC,SAASA;MLekCN,MAAMA;;MAnB/BE,UAAUA;MAFoKJ,SAASA;;MCxD/HC,UAAUA;;;;;;;;;;;;;;;;;;;MJA5CJ,GAAGA;;;;;;;;;MDAGD,KAAKA;;;;MEA2DE,KAAKA",
"ignoreList": []
}
1 change: 0 additions & 1 deletion src/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
/**
* @remarks Drop-in replacement for the [SAM cli](https://github.com/aws/aws-sam-cli).
*
* @summary
* Expands the template in [expand](./expand.js).
*
* @module
Expand Down
1 change: 0 additions & 1 deletion src/expand.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
//@ts-check

/**
* @summary
* Expands the template using metadata defined in [SAM template](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html).
*
* Plugins add their own schemas to config.
Expand Down
1 change: 0 additions & 1 deletion src/freeze.js
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/**
* @summary
* Recursive object freezer.
* @module
**/
Expand Down
2 changes: 0 additions & 2 deletions src/log.js
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
* Uses [node:util.formatWithOptions](https://nodejs.org/docs/latest/api/util.html#utilformatwithoptionsinspectoptions-format-args).
* Use --debug flag to see verbose log output.
*
* @summary
* Mimic same log output format as defined in [SAM cli](https://github.com/aws/aws-sam-cli).
*
* @example
Expand All @@ -26,7 +25,6 @@ import { formatWithOptions } from 'node:util'
* Uses [node:util.formatWithOptions](https://nodejs.org/docs/latest/api/util.html#utilformatwithoptionsinspectoptions-format-args).
* Use --debug flag to see verbose log output.
*
* @summary
* Mimic same log output format as defined in [SAM cli](https://github.com/aws/aws-sam-cli).
*
* @example
Expand Down
1 change: 0 additions & 1 deletion src/parse.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
/**
* @typedef {(data: string, type: 'toml' | 'yaml') => any} Parse
*
* @summary
* 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.
*
* Provides a parse method that parses yaml, json, or toml.
Expand Down
1 change: 0 additions & 1 deletion src/plugins/parameter-overrides.js
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@
* Override values from json/yaml/toml files, or exports from .mjs and .mts files.
* with --parameter-overrides for sam build, sync, and deploy.
*
* @summary
* Override parameter values.
*
* @example
Expand Down
1 change: 0 additions & 1 deletion src/plugins/run-script-hooks.js
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,6 @@
* @remarks
* Pre and Post Script hooks for build, package, deploy, and delete.
*
* @summary
* Run scripts with defined arguments.
*
* @example
Expand Down
1 change: 0 additions & 1 deletion src/plugins/types.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// @ts-check

/**
* @summary
* Type definitions for plugins.
*
* @module
Expand Down
1 change: 0 additions & 1 deletion src/resolve.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
// @ts-check

/**
* @summary
* Resolve mjs, mts, yaml, json, and toml files.
*
* @module
Expand Down
2 changes: 0 additions & 2 deletions src/spawn.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,6 @@
/**
* @typedef {(cmd: string, args: string[], options?: import('node:child_process').SpawnOptions) => Promise<void | string>} Spawn
*
* @summary
* [node:child_process](https://nodejs.org/docs/latest/api/child_process.html#child-process).spawn wrapper.
*
* @example
Expand All @@ -30,7 +29,6 @@ import { Buffer } from 'node:buffer'
const windows = os.platform() === 'win32'

/**
* @summary
* [node:child_process](https://nodejs.org/docs/latest/api/child_process.html#child-process).spawn wrapper.
*
* @example
Expand Down
3 changes: 2 additions & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,6 @@
"npm": "https://www.npmjs.com/package/@starterstack/sam-expand",
"Socket": "https://socket.dev/npm/package/@starterstack/sam-expand",
"starterstack": "https://github.com/orgs/starterstack/repositories"
}
},
"highlightLanguages": ["typescript", "javascript", "yaml", "sh"]
}

0 comments on commit 302b596

Please # to comment.