diff --git a/404.html b/404.html index d175b7411..97356edd8 100644 --- a/404.html +++ b/404.html @@ -4,7 +4,7 @@ Page Not Found | Boost - + diff --git a/api/args/class/ParseError/index.html b/api/args/class/ParseError/index.html index 595733167..e4a88354e 100644 --- a/api/args/class/ParseError/index.html +++ b/api/args/class/ParseError/index.html @@ -4,7 +4,7 @@ ParseError | API | Boost - + diff --git a/api/args/class/ValidationError/index.html b/api/args/class/ValidationError/index.html index 4bf9d41c7..36b09a520 100644 --- a/api/args/class/ValidationError/index.html +++ b/api/args/class/ValidationError/index.html @@ -4,7 +4,7 @@ ValidationError | API | Boost - + diff --git a/api/args/function/format/index.html b/api/args/function/format/index.html index 9b637aa7f..a0267325f 100644 --- a/api/args/function/format/index.html +++ b/api/args/function/format/index.html @@ -4,7 +4,7 @@ format | API | Boost - + diff --git a/api/args/function/parse/index.html b/api/args/function/parse/index.html index b27591375..32b063a32 100644 --- a/api/args/function/parse/index.html +++ b/api/args/function/parse/index.html @@ -4,7 +4,7 @@ parse | API | Boost - + diff --git a/api/args/function/parseInContext/index.html b/api/args/function/parseInContext/index.html index 006440ac5..2a4e5d067 100644 --- a/api/args/function/parseInContext/index.html +++ b/api/args/function/parseInContext/index.html @@ -4,7 +4,7 @@ parseInContext | API | Boost - + diff --git a/api/args/index.html b/api/args/index.html index e6953412e..1c57a63c7 100644 --- a/api/args/index.html +++ b/api/args/index.html @@ -4,7 +4,7 @@ @boost/args | API | Boost - + diff --git a/api/args/interface/Arg/index.html b/api/args/interface/Arg/index.html index 869ac0ae5..c33d2cd0b 100644 --- a/api/args/interface/Arg/index.html +++ b/api/args/interface/Arg/index.html @@ -4,7 +4,7 @@ Arg | API | Boost - + diff --git a/api/args/interface/Arguments/index.html b/api/args/interface/Arguments/index.html index e5330ee53..d994a3d4e 100644 --- a/api/args/interface/Arguments/index.html +++ b/api/args/interface/Arguments/index.html @@ -4,7 +4,7 @@ Arguments | API | Boost - + diff --git a/api/args/interface/Category/index.html b/api/args/interface/Category/index.html index f803c3f7a..f27967035 100644 --- a/api/args/interface/Category/index.html +++ b/api/args/interface/Category/index.html @@ -4,7 +4,7 @@ Category | API | Boost - + diff --git a/api/args/interface/Command/index.html b/api/args/interface/Command/index.html index d0063b3af..e65fb0fd5 100644 --- a/api/args/interface/Command/index.html +++ b/api/args/interface/Command/index.html @@ -4,7 +4,7 @@ Command | API | Boost - + diff --git a/api/args/interface/Config/index.html b/api/args/interface/Config/index.html index 11436148d..d8eed0045 100644 --- a/api/args/interface/Config/index.html +++ b/api/args/interface/Config/index.html @@ -4,7 +4,7 @@ Config | API | Boost - + diff --git a/api/args/interface/Flag/index.html b/api/args/interface/Flag/index.html index e89f5b601..c1fb726a4 100644 --- a/api/args/interface/Flag/index.html +++ b/api/args/interface/Flag/index.html @@ -4,7 +4,7 @@ Flag | API | Boost - + diff --git a/api/args/interface/MultipleOption/index.html b/api/args/interface/MultipleOption/index.html index 4358eff4c..8f8fb18f8 100644 --- a/api/args/interface/MultipleOption/index.html +++ b/api/args/interface/MultipleOption/index.html @@ -4,7 +4,7 @@ MultipleOption | API | Boost - + diff --git a/api/args/interface/Option/index.html b/api/args/interface/Option/index.html index ccf67d68c..0dfec69b0 100644 --- a/api/args/interface/Option/index.html +++ b/api/args/interface/Option/index.html @@ -4,7 +4,7 @@ Option | API | Boost - + diff --git a/api/args/interface/Param/index.html b/api/args/interface/Param/index.html index 5e9a5938b..88366d8d5 100644 --- a/api/args/interface/Param/index.html +++ b/api/args/interface/Param/index.html @@ -4,7 +4,7 @@ Param | API | Boost - + diff --git a/api/args/interface/ParserOptions/index.html b/api/args/interface/ParserOptions/index.html index 84a1b9389..d31bdd257 100644 --- a/api/args/interface/ParserOptions/index.html +++ b/api/args/interface/ParserOptions/index.html @@ -4,7 +4,7 @@ ParserOptions | API | Boost - + diff --git a/api/args/interface/ParserSettings/index.html b/api/args/interface/ParserSettings/index.html index bcfcff1c7..47978de3a 100644 --- a/api/args/interface/ParserSettings/index.html +++ b/api/args/interface/ParserSettings/index.html @@ -4,7 +4,7 @@ ParserSettings | API | Boost - + diff --git a/api/args/interface/SingleOption/index.html b/api/args/interface/SingleOption/index.html index e01521a82..071d73a28 100644 --- a/api/args/interface/SingleOption/index.html +++ b/api/args/interface/SingleOption/index.html @@ -4,7 +4,7 @@ SingleOption | API | Boost - + diff --git a/api/cli-react/class/Failure/index.html b/api/cli-react/class/Failure/index.html index 30818ea45..c4bf664da 100644 --- a/api/cli-react/class/Failure/index.html +++ b/api/cli-react/class/Failure/index.html @@ -4,10 +4,10 @@ Failure | API | Boost - + -
Skip to main content

Failure

A React component that renders a failure state for errors and warnings.

Hierarchy

Index

Constructors

Methods

Constructors

externalconstructor

Methods

render

  • render(): Element

renderCodeFrame

  • renderCodeFrame(): null | Element

renderStackTrace

  • renderStackTrace(): null | Element

renderWarnings

  • renderWarnings(): null | Element

shouldHideStackTrace

  • shouldHideStackTrace(): boolean
+
Skip to main content

Failure

A React component that renders a failure state for errors and warnings.

Hierarchy

Index

Constructors

Methods

Constructors

externalconstructor

Methods

render

  • render(): Element

renderCodeFrame

  • renderCodeFrame(): null | Element

renderStackTrace

  • renderStackTrace(): null | Element

renderWarnings

  • renderWarnings(): null | Element

shouldHideStackTrace

  • shouldHideStackTrace(): boolean
\ No newline at end of file diff --git a/api/cli-react/function/Confirm/index.html b/api/cli-react/function/Confirm/index.html index b2ebd6f1f..ded3c6814 100644 --- a/api/cli-react/function/Confirm/index.html +++ b/api/cli-react/function/Confirm/index.html @@ -4,7 +4,7 @@ Confirm | API | Boost - + diff --git a/api/cli-react/function/Header/index.html b/api/cli-react/function/Header/index.html index 3208796f7..049399bf5 100644 --- a/api/cli-react/function/Header/index.html +++ b/api/cli-react/function/Header/index.html @@ -4,7 +4,7 @@ Header | API | Boost - + diff --git a/api/cli-react/function/Help/index.html b/api/cli-react/function/Help/index.html index 12fd28985..39ce45e8f 100644 --- a/api/cli-react/function/Help/index.html +++ b/api/cli-react/function/Help/index.html @@ -4,7 +4,7 @@ Help | API | Boost - + diff --git a/api/cli-react/function/HiddenInput/index.html b/api/cli-react/function/HiddenInput/index.html index 1e5287d91..c7c8c5904 100644 --- a/api/cli-react/function/HiddenInput/index.html +++ b/api/cli-react/function/HiddenInput/index.html @@ -4,7 +4,7 @@ HiddenInput | API | Boost - + diff --git a/api/cli-react/function/IndexHelp/index.html b/api/cli-react/function/IndexHelp/index.html index d51047020..5c32106a2 100644 --- a/api/cli-react/function/IndexHelp/index.html +++ b/api/cli-react/function/IndexHelp/index.html @@ -4,7 +4,7 @@ IndexHelp | API | Boost - + diff --git a/api/cli-react/function/Input/index.html b/api/cli-react/function/Input/index.html index 0128af298..146d284d7 100644 --- a/api/cli-react/function/Input/index.html +++ b/api/cli-react/function/Input/index.html @@ -4,7 +4,7 @@ Input | API | Boost - + diff --git a/api/cli-react/function/MultiSelect/index.html b/api/cli-react/function/MultiSelect/index.html index 70669fc2e..f29876b19 100644 --- a/api/cli-react/function/MultiSelect/index.html +++ b/api/cli-react/function/MultiSelect/index.html @@ -4,7 +4,7 @@ MultiSelect | API | Boost - + diff --git a/api/cli-react/function/PasswordInput/index.html b/api/cli-react/function/PasswordInput/index.html index e2c7831ab..3195daf05 100644 --- a/api/cli-react/function/PasswordInput/index.html +++ b/api/cli-react/function/PasswordInput/index.html @@ -4,7 +4,7 @@ PasswordInput | API | Boost - + diff --git a/api/cli-react/function/Select/index.html b/api/cli-react/function/Select/index.html index 38faac9d9..351c61146 100644 --- a/api/cli-react/function/Select/index.html +++ b/api/cli-react/function/Select/index.html @@ -4,7 +4,7 @@ Select | API | Boost - + diff --git a/api/cli-react/function/Style/index.html b/api/cli-react/function/Style/index.html index 0b7e4bca1..815cb336d 100644 --- a/api/cli-react/function/Style/index.html +++ b/api/cli-react/function/Style/index.html @@ -4,7 +4,7 @@ Style | API | Boost - + diff --git a/api/cli-react/function/normalizeOptions/index.html b/api/cli-react/function/normalizeOptions/index.html index 54cbc80d5..568cc1c7c 100644 --- a/api/cli-react/function/normalizeOptions/index.html +++ b/api/cli-react/function/normalizeOptions/index.html @@ -4,7 +4,7 @@ normalizeOptions | API | Boost - + diff --git a/api/cli-react/function/useDimensions/index.html b/api/cli-react/function/useDimensions/index.html index 51a5a2372..1da45989c 100644 --- a/api/cli-react/function/useDimensions/index.html +++ b/api/cli-react/function/useDimensions/index.html @@ -4,7 +4,7 @@ useDimensions | API | Boost - + diff --git a/api/cli-react/function/useIsMounted/index.html b/api/cli-react/function/useIsMounted/index.html index 3ef40e6d2..9acac90ba 100644 --- a/api/cli-react/function/useIsMounted/index.html +++ b/api/cli-react/function/useIsMounted/index.html @@ -4,7 +4,7 @@ useIsMounted | API | Boost - + diff --git a/api/cli-react/function/useListNavigation/index.html b/api/cli-react/function/useListNavigation/index.html index 9940125df..029647247 100644 --- a/api/cli-react/function/useListNavigation/index.html +++ b/api/cli-react/function/useListNavigation/index.html @@ -4,7 +4,7 @@ useListNavigation | API | Boost - + diff --git a/api/cli-react/function/useProgram/index.html b/api/cli-react/function/useProgram/index.html index 58dafa7f3..e01b111f4 100644 --- a/api/cli-react/function/useProgram/index.html +++ b/api/cli-react/function/useProgram/index.html @@ -4,7 +4,7 @@ useProgram | API | Boost - + diff --git a/api/cli-react/function/useRenderLoop/index.html b/api/cli-react/function/useRenderLoop/index.html index 0b5a6aa01..450794db2 100644 --- a/api/cli-react/function/useRenderLoop/index.html +++ b/api/cli-react/function/useRenderLoop/index.html @@ -4,7 +4,7 @@ useRenderLoop | API | Boost - + diff --git a/api/cli-react/index.html b/api/cli-react/index.html index 9d215bbac..61a50bc34 100644 --- a/api/cli-react/index.html +++ b/api/cli-react/index.html @@ -4,7 +4,7 @@ @boost/cli/react | API | Boost - + diff --git a/api/cli-react/interface/ConfirmProps/index.html b/api/cli-react/interface/ConfirmProps/index.html index c8ccd97fb..5d6fd763d 100644 --- a/api/cli-react/interface/ConfirmProps/index.html +++ b/api/cli-react/interface/ConfirmProps/index.html @@ -4,7 +4,7 @@ ConfirmProps | API | Boost - + diff --git a/api/cli-react/interface/FailureProps/index.html b/api/cli-react/interface/FailureProps/index.html index e47302516..1fa19041f 100644 --- a/api/cli-react/interface/FailureProps/index.html +++ b/api/cli-react/interface/FailureProps/index.html @@ -4,7 +4,7 @@ FailureProps | API | Boost - + diff --git a/api/cli-react/interface/HeaderProps/index.html b/api/cli-react/interface/HeaderProps/index.html index c3416d174..261c34085 100644 --- a/api/cli-react/interface/HeaderProps/index.html +++ b/api/cli-react/interface/HeaderProps/index.html @@ -4,7 +4,7 @@ HeaderProps | API | Boost - + diff --git a/api/cli-react/interface/HelpProps/index.html b/api/cli-react/interface/HelpProps/index.html index d18d7dcd4..7946931fe 100644 --- a/api/cli-react/interface/HelpProps/index.html +++ b/api/cli-react/interface/HelpProps/index.html @@ -4,7 +4,7 @@ HelpProps | API | Boost - + diff --git a/api/cli-react/interface/IndexHelpProps/index.html b/api/cli-react/interface/IndexHelpProps/index.html index a915d970b..7e760fa01 100644 --- a/api/cli-react/interface/IndexHelpProps/index.html +++ b/api/cli-react/interface/IndexHelpProps/index.html @@ -4,7 +4,7 @@ IndexHelpProps | API | Boost - + diff --git a/api/cli-react/interface/InputProps/index.html b/api/cli-react/interface/InputProps/index.html index 4e1dec867..b4b85a2fa 100644 --- a/api/cli-react/interface/InputProps/index.html +++ b/api/cli-react/interface/InputProps/index.html @@ -4,7 +4,7 @@ InputProps | API | Boost - + diff --git a/api/cli-react/interface/MultiSelectProps/index.html b/api/cli-react/interface/MultiSelectProps/index.html index 4fca42184..cfb931413 100644 --- a/api/cli-react/interface/MultiSelectProps/index.html +++ b/api/cli-react/interface/MultiSelectProps/index.html @@ -4,7 +4,7 @@ MultiSelectProps | API | Boost - + diff --git a/api/cli-react/interface/SelectOption/index.html b/api/cli-react/interface/SelectOption/index.html index 92dbacbb3..ebe9a1ded 100644 --- a/api/cli-react/interface/SelectOption/index.html +++ b/api/cli-react/interface/SelectOption/index.html @@ -4,7 +4,7 @@ SelectOption | API | Boost - + diff --git a/api/cli-react/interface/SelectProps/index.html b/api/cli-react/interface/SelectProps/index.html index 7d69fd677..66a93e345 100644 --- a/api/cli-react/interface/SelectProps/index.html +++ b/api/cli-react/interface/SelectProps/index.html @@ -4,7 +4,7 @@ SelectProps | API | Boost - + diff --git a/api/cli-react/interface/StyleProps/index.html b/api/cli-react/interface/StyleProps/index.html index 71267f664..632b45893 100644 --- a/api/cli-react/interface/StyleProps/index.html +++ b/api/cli-react/interface/StyleProps/index.html @@ -4,7 +4,7 @@ StyleProps | API | Boost - + diff --git a/api/cli-test/class/MockReadStream/index.html b/api/cli-test/class/MockReadStream/index.html index cf813a735..95e494163 100644 --- a/api/cli-test/class/MockReadStream/index.html +++ b/api/cli-test/class/MockReadStream/index.html @@ -4,7 +4,7 @@ MockReadStream | API | Boost - + diff --git a/api/cli-test/class/MockWriteStream/index.html b/api/cli-test/class/MockWriteStream/index.html index e1ca85670..ac94fa77c 100644 --- a/api/cli-test/class/MockWriteStream/index.html +++ b/api/cli-test/class/MockWriteStream/index.html @@ -4,7 +4,7 @@ MockWriteStream | API | Boost - + diff --git a/api/cli-test/function/mockProgram/index.html b/api/cli-test/function/mockProgram/index.html index 7be3b9e81..8340102b5 100644 --- a/api/cli-test/function/mockProgram/index.html +++ b/api/cli-test/function/mockProgram/index.html @@ -4,7 +4,7 @@ mockProgram | API | Boost - + diff --git a/api/cli-test/function/mockStreams/index.html b/api/cli-test/function/mockStreams/index.html index 45b5e4f31..305d1888c 100644 --- a/api/cli-test/function/mockStreams/index.html +++ b/api/cli-test/function/mockStreams/index.html @@ -4,7 +4,7 @@ mockStreams | API | Boost - + diff --git a/api/cli-test/function/renderComponent/index.html b/api/cli-test/function/renderComponent/index.html index 26a435837..9be3453bf 100644 --- a/api/cli-test/function/renderComponent/index.html +++ b/api/cli-test/function/renderComponent/index.html @@ -4,7 +4,7 @@ renderComponent | API | Boost - + diff --git a/api/cli-test/function/runCommand/index.html b/api/cli-test/function/runCommand/index.html index be3441f64..083f7e2ef 100644 --- a/api/cli-test/function/runCommand/index.html +++ b/api/cli-test/function/runCommand/index.html @@ -4,7 +4,7 @@ runCommand | API | Boost - + diff --git a/api/cli-test/function/runProgram/index.html b/api/cli-test/function/runProgram/index.html index c41250d31..daef2dde5 100644 --- a/api/cli-test/function/runProgram/index.html +++ b/api/cli-test/function/runProgram/index.html @@ -4,7 +4,7 @@ runProgram | API | Boost - + diff --git a/api/cli-test/function/runTask/index.html b/api/cli-test/function/runTask/index.html index 26ab114f1..10a920ead 100644 --- a/api/cli-test/function/runTask/index.html +++ b/api/cli-test/function/runTask/index.html @@ -4,7 +4,7 @@ runTask | API | Boost - + diff --git a/api/cli-test/index.html b/api/cli-test/index.html index 8820aca3a..ec618dc7f 100644 --- a/api/cli-test/index.html +++ b/api/cli-test/index.html @@ -4,7 +4,7 @@ @boost/cli/test | API | Boost - + diff --git a/api/cli/class/Command/index.html b/api/cli/class/Command/index.html index bc8ba72e2..a53bd97e4 100644 --- a/api/cli/class/Command/index.html +++ b/api/cli/class/Command/index.html @@ -4,7 +4,7 @@ Command | API | Boost - + diff --git a/api/cli/class/Program/index.html b/api/cli/class/Program/index.html index e2fc8ad47..072ad1f6d 100644 --- a/api/cli/class/Program/index.html +++ b/api/cli/class/Program/index.html @@ -4,7 +4,7 @@ Program | API | Boost - + diff --git a/api/cli/function/Config/index.html b/api/cli/function/Config/index.html index 2e7d7da90..4812a2849 100644 --- a/api/cli/function/Config/index.html +++ b/api/cli/function/Config/index.html @@ -4,7 +4,7 @@ Config | API | Boost - + diff --git a/api/cli/function/applyMarkdown/index.html b/api/cli/function/applyMarkdown/index.html index 7306f633a..4243a6090 100644 --- a/api/cli/function/applyMarkdown/index.html +++ b/api/cli/function/applyMarkdown/index.html @@ -4,7 +4,7 @@ applyMarkdown | API | Boost - + diff --git a/api/cli/function/applyStyle/index.html b/api/cli/function/applyStyle/index.html index d22c93a49..a3ed70e63 100644 --- a/api/cli/function/applyStyle/index.html +++ b/api/cli/function/applyStyle/index.html @@ -4,7 +4,7 @@ applyStyle | API | Boost - + diff --git a/api/cli/function/checkNodeRequirement/index.html b/api/cli/function/checkNodeRequirement/index.html index 0a8150e18..11f944175 100644 --- a/api/cli/function/checkNodeRequirement/index.html +++ b/api/cli/function/checkNodeRequirement/index.html @@ -4,7 +4,7 @@ checkNodeRequirement | API | Boost - + diff --git a/api/cli/function/checkPackageOutdated/index.html b/api/cli/function/checkPackageOutdated/index.html index ad3ff0883..8087cf37e 100644 --- a/api/cli/function/checkPackageOutdated/index.html +++ b/api/cli/function/checkPackageOutdated/index.html @@ -4,7 +4,7 @@ checkPackageOutdated | API | Boost - + diff --git a/api/cli/function/formatCommandCall/index.html b/api/cli/function/formatCommandCall/index.html index bd8324d57..6b27ed548 100644 --- a/api/cli/function/formatCommandCall/index.html +++ b/api/cli/function/formatCommandCall/index.html @@ -4,7 +4,7 @@ formatCommandCall | API | Boost - + diff --git a/api/cli/function/formatDescription/index.html b/api/cli/function/formatDescription/index.html index 8f7f8c8a1..cb0055085 100644 --- a/api/cli/function/formatDescription/index.html +++ b/api/cli/function/formatDescription/index.html @@ -4,7 +4,7 @@ formatDescription | API | Boost - + diff --git a/api/cli/function/formatType/index.html b/api/cli/function/formatType/index.html index dc276f5c8..a38f282d7 100644 --- a/api/cli/function/formatType/index.html +++ b/api/cli/function/formatType/index.html @@ -4,7 +4,7 @@ formatType | API | Boost - + diff --git a/api/cli/function/formatValue/index.html b/api/cli/function/formatValue/index.html index 16b2bad24..0bf7e8aed 100644 --- a/api/cli/function/formatValue/index.html +++ b/api/cli/function/formatValue/index.html @@ -4,7 +4,7 @@ formatValue | API | Boost - + diff --git a/api/cli/function/getLongestWidth/index.html b/api/cli/function/getLongestWidth/index.html index f8d5aa34e..dff803dac 100644 --- a/api/cli/function/getLongestWidth/index.html +++ b/api/cli/function/getLongestWidth/index.html @@ -4,7 +4,7 @@ getLongestWidth | API | Boost - + diff --git a/api/cli/function/groupByCategory/index.html b/api/cli/function/groupByCategory/index.html index 4d920353a..edc710cfd 100644 --- a/api/cli/function/groupByCategory/index.html +++ b/api/cli/function/groupByCategory/index.html @@ -4,7 +4,7 @@ groupByCategory | API | Boost - + diff --git a/api/cli/function/isArgvSize/index.html b/api/cli/function/isArgvSize/index.html index 0af6a6ebb..10edc1fd6 100644 --- a/api/cli/function/isArgvSize/index.html +++ b/api/cli/function/isArgvSize/index.html @@ -4,7 +4,7 @@ isArgvSize | API | Boost - + diff --git a/api/cli/function/loadTheme/index.html b/api/cli/function/loadTheme/index.html index 73b1e8ba0..5fabb9e26 100644 --- a/api/cli/function/loadTheme/index.html +++ b/api/cli/function/loadTheme/index.html @@ -4,7 +4,7 @@ loadTheme | API | Boost - + diff --git a/api/cli/function/mapCommandMetadata/index.html b/api/cli/function/mapCommandMetadata/index.html index 264e26bb5..8f5789d84 100644 --- a/api/cli/function/mapCommandMetadata/index.html +++ b/api/cli/function/mapCommandMetadata/index.html @@ -4,7 +4,7 @@ mapCommandMetadata | API | Boost - + diff --git a/api/cli/index.html b/api/cli/index.html index 22b6e8dd2..99fce023d 100644 --- a/api/cli/index.html +++ b/api/cli/index.html @@ -4,7 +4,7 @@ @boost/cli | API | Boost - + diff --git a/api/cli/interface/Arguments/index.html b/api/cli/interface/Arguments/index.html index 0a1ee5907..b71841bac 100644 --- a/api/cli/interface/Arguments/index.html +++ b/api/cli/interface/Arguments/index.html @@ -4,7 +4,7 @@ Arguments | API | Boost - + diff --git a/api/cli/interface/Category/index.html b/api/cli/interface/Category/index.html index fbfd4198d..c05c9a124 100644 --- a/api/cli/interface/Category/index.html +++ b/api/cli/interface/Category/index.html @@ -4,7 +4,7 @@ Category | API | Boost - + diff --git a/api/cli/interface/CommandConfig/index.html b/api/cli/interface/CommandConfig/index.html index 8f31a31ae..632c23e21 100644 --- a/api/cli/interface/CommandConfig/index.html +++ b/api/cli/interface/CommandConfig/index.html @@ -4,7 +4,7 @@ CommandConfig | API | Boost - + diff --git a/api/cli/interface/CommandMetadata/index.html b/api/cli/interface/CommandMetadata/index.html index 80cb48b0f..c5aed8acb 100644 --- a/api/cli/interface/CommandMetadata/index.html +++ b/api/cli/interface/CommandMetadata/index.html @@ -4,7 +4,7 @@ CommandMetadata | API | Boost - + diff --git a/api/cli/interface/CommandStaticConfig/index.html b/api/cli/interface/CommandStaticConfig/index.html index 842344ff5..0b477398a 100644 --- a/api/cli/interface/CommandStaticConfig/index.html +++ b/api/cli/interface/CommandStaticConfig/index.html @@ -4,7 +4,7 @@ CommandStaticConfig | API | Boost - + diff --git a/api/cli/interface/Commandable/index.html b/api/cli/interface/Commandable/index.html index de8c41ece..3da7bd7c1 100644 --- a/api/cli/interface/Commandable/index.html +++ b/api/cli/interface/Commandable/index.html @@ -4,7 +4,7 @@ Commandable | API | Boost - + diff --git a/api/cli/interface/Flag/index.html b/api/cli/interface/Flag/index.html index 8a9560eba..ac3394ca8 100644 --- a/api/cli/interface/Flag/index.html +++ b/api/cli/interface/Flag/index.html @@ -4,7 +4,7 @@ Flag | API | Boost - + diff --git a/api/cli/interface/GlobalOptions/index.html b/api/cli/interface/GlobalOptions/index.html index fd5d69359..7e2b45efe 100644 --- a/api/cli/interface/GlobalOptions/index.html +++ b/api/cli/interface/GlobalOptions/index.html @@ -4,7 +4,7 @@ GlobalOptions | API | Boost - + diff --git a/api/cli/interface/MultipleOption/index.html b/api/cli/interface/MultipleOption/index.html index 4d741e28f..d28fe5afa 100644 --- a/api/cli/interface/MultipleOption/index.html +++ b/api/cli/interface/MultipleOption/index.html @@ -4,7 +4,7 @@ MultipleOption | API | Boost - + diff --git a/api/cli/interface/Option/index.html b/api/cli/interface/Option/index.html index 6265fb29d..bfa15b73e 100644 --- a/api/cli/interface/Option/index.html +++ b/api/cli/interface/Option/index.html @@ -4,7 +4,7 @@ Option | API | Boost - + diff --git a/api/cli/interface/OptionInitializer/index.html b/api/cli/interface/OptionInitializer/index.html index dcb725fbe..376c8e7d0 100644 --- a/api/cli/interface/OptionInitializer/index.html +++ b/api/cli/interface/OptionInitializer/index.html @@ -4,7 +4,7 @@ OptionInitializer | API | Boost - + diff --git a/api/cli/interface/Param/index.html b/api/cli/interface/Param/index.html index 72692b229..a394280e4 100644 --- a/api/cli/interface/Param/index.html +++ b/api/cli/interface/Param/index.html @@ -4,7 +4,7 @@ Param | API | Boost - + diff --git a/api/cli/interface/ParserOptions/index.html b/api/cli/interface/ParserOptions/index.html index b9e281616..06a03a05f 100644 --- a/api/cli/interface/ParserOptions/index.html +++ b/api/cli/interface/ParserOptions/index.html @@ -4,7 +4,7 @@ ParserOptions | API | Boost - + diff --git a/api/cli/interface/ProgramContextType/index.html b/api/cli/interface/ProgramContextType/index.html index 657f89f60..5a0e0337a 100644 --- a/api/cli/interface/ProgramContextType/index.html +++ b/api/cli/interface/ProgramContextType/index.html @@ -4,7 +4,7 @@ ProgramContextType | API | Boost - + diff --git a/api/cli/interface/ProgramOptions/index.html b/api/cli/interface/ProgramOptions/index.html index e48803433..ab897f5ff 100644 --- a/api/cli/interface/ProgramOptions/index.html +++ b/api/cli/interface/ProgramOptions/index.html @@ -4,7 +4,7 @@ ProgramOptions | API | Boost - + diff --git a/api/cli/interface/ProgramStreams/index.html b/api/cli/interface/ProgramStreams/index.html index d0f3fc212..2e5795201 100644 --- a/api/cli/interface/ProgramStreams/index.html +++ b/api/cli/interface/ProgramStreams/index.html @@ -4,7 +4,7 @@ ProgramStreams | API | Boost - + diff --git a/api/cli/interface/SingleOption/index.html b/api/cli/interface/SingleOption/index.html index a1101d771..f125275fa 100644 --- a/api/cli/interface/SingleOption/index.html +++ b/api/cli/interface/SingleOption/index.html @@ -4,7 +4,7 @@ SingleOption | API | Boost - + diff --git a/api/cli/namespace/Arg/index.html b/api/cli/namespace/Arg/index.html index 595b80bab..bb7a8175c 100644 --- a/api/cli/namespace/Arg/index.html +++ b/api/cli/namespace/Arg/index.html @@ -4,7 +4,7 @@ Arg | API | Boost - + diff --git a/api/common-optimal/index.html b/api/common-optimal/index.html index 2de8f05b4..4ecf0f846 100644 --- a/api/common-optimal/index.html +++ b/api/common-optimal/index.html @@ -4,7 +4,7 @@ @boost/common/optimal | API | Boost - + diff --git a/api/common-test/function/mockFilePath/index.html b/api/common-test/function/mockFilePath/index.html index 2055e08b2..ae7466d13 100644 --- a/api/common-test/function/mockFilePath/index.html +++ b/api/common-test/function/mockFilePath/index.html @@ -4,7 +4,7 @@ mockFilePath | API | Boost - + diff --git a/api/common-test/function/mockModulePath/index.html b/api/common-test/function/mockModulePath/index.html index a43004e54..92f3d5c96 100644 --- a/api/common-test/function/mockModulePath/index.html +++ b/api/common-test/function/mockModulePath/index.html @@ -4,7 +4,7 @@ mockModulePath | API | Boost - + diff --git a/api/common-test/function/mockNormalizedFilePath/index.html b/api/common-test/function/mockNormalizedFilePath/index.html index 60e3c4196..89b756111 100644 --- a/api/common-test/function/mockNormalizedFilePath/index.html +++ b/api/common-test/function/mockNormalizedFilePath/index.html @@ -4,7 +4,7 @@ mockNormalizedFilePath | API | Boost - + diff --git a/api/common-test/function/normalizeSeparators/index.html b/api/common-test/function/normalizeSeparators/index.html index 6c04f58d9..218fd026b 100644 --- a/api/common-test/function/normalizeSeparators/index.html +++ b/api/common-test/function/normalizeSeparators/index.html @@ -4,7 +4,7 @@ normalizeSeparators | API | Boost - + diff --git a/api/common-test/index.html b/api/common-test/index.html index f3bba485a..ecc59848c 100644 --- a/api/common-test/index.html +++ b/api/common-test/index.html @@ -4,7 +4,7 @@ @boost/common/test | API | Boost - + diff --git a/api/common/class/Contract/index.html b/api/common/class/Contract/index.html index e1a5792cc..bb8f619bc 100644 --- a/api/common/class/Contract/index.html +++ b/api/common/class/Contract/index.html @@ -4,7 +4,7 @@ Contract | API | Boost - + diff --git a/api/common/class/ExitError/index.html b/api/common/class/ExitError/index.html index fc1554408..063b62812 100644 --- a/api/common/class/ExitError/index.html +++ b/api/common/class/ExitError/index.html @@ -4,7 +4,7 @@ ExitError | API | Boost - + diff --git a/api/common/class/ModulePath/index.html b/api/common/class/ModulePath/index.html index 65747b3ad..56cecd4d7 100644 --- a/api/common/class/ModulePath/index.html +++ b/api/common/class/ModulePath/index.html @@ -4,7 +4,7 @@ ModulePath | API | Boost - + diff --git a/api/common/class/PackageGraph/index.html b/api/common/class/PackageGraph/index.html index 77f094712..93865bfd4 100644 --- a/api/common/class/PackageGraph/index.html +++ b/api/common/class/PackageGraph/index.html @@ -4,7 +4,7 @@ PackageGraph | API | Boost - + diff --git a/api/common/class/Path/index.html b/api/common/class/Path/index.html index 8d1ac36d7..0408a1ba2 100644 --- a/api/common/class/Path/index.html +++ b/api/common/class/Path/index.html @@ -8,7 +8,7 @@ "/" on Linux/MacOS, and "\\" on Windows."> - + diff --git a/api/common/class/PathResolver/index.html b/api/common/class/PathResolver/index.html index 20741e6ba..dc9af2c45 100644 --- a/api/common/class/PathResolver/index.html +++ b/api/common/class/PathResolver/index.html @@ -4,7 +4,7 @@ PathResolver | API | Boost - + diff --git a/api/common/class/Project/index.html b/api/common/class/Project/index.html index c1f6f27f4..a7c926cb5 100644 --- a/api/common/class/Project/index.html +++ b/api/common/class/Project/index.html @@ -4,7 +4,7 @@ Project | API | Boost - + diff --git a/api/common/class/VirtualPath/index.html b/api/common/class/VirtualPath/index.html index 10980ec8e..73cbd2fb8 100644 --- a/api/common/class/VirtualPath/index.html +++ b/api/common/class/VirtualPath/index.html @@ -8,7 +8,7 @@ Useful for paths found in configurations, globs, etc."> - + diff --git a/api/common/function/Bind/index.html b/api/common/function/Bind/index.html index 238a0037a..6f98584e3 100644 --- a/api/common/function/Bind/index.html +++ b/api/common/function/Bind/index.html @@ -4,7 +4,7 @@ Bind | API | Boost - + diff --git a/api/common/function/Debounce/index.html b/api/common/function/Debounce/index.html index dd7cfad8b..135973279 100644 --- a/api/common/function/Debounce/index.html +++ b/api/common/function/Debounce/index.html @@ -4,7 +4,7 @@ Debounce | API | Boost - + diff --git a/api/common/function/Deprecate/index.html b/api/common/function/Deprecate/index.html index b01b99c9f..83b2ab6b2 100644 --- a/api/common/function/Deprecate/index.html +++ b/api/common/function/Deprecate/index.html @@ -4,7 +4,7 @@ Deprecate | API | Boost - + diff --git a/api/common/function/Memoize/index.html b/api/common/function/Memoize/index.html index b3de00bff..30c532e20 100644 --- a/api/common/function/Memoize/index.html +++ b/api/common/function/Memoize/index.html @@ -4,7 +4,7 @@ Memoize | API | Boost - + diff --git a/api/common/function/Throttle/index.html b/api/common/function/Throttle/index.html index f390d26e5..e528304e9 100644 --- a/api/common/function/Throttle/index.html +++ b/api/common/function/Throttle/index.html @@ -4,7 +4,7 @@ Throttle | API | Boost - + diff --git a/api/common/function/createBlueprint/index.html b/api/common/function/createBlueprint/index.html index 0b477d8a0..be70b99f1 100644 --- a/api/common/function/createBlueprint/index.html +++ b/api/common/function/createBlueprint/index.html @@ -4,7 +4,7 @@ createBlueprint | API | Boost - + diff --git a/api/common/function/deepFreeze/index.html b/api/common/function/deepFreeze/index.html index 0bedf806b..ac6eac897 100644 --- a/api/common/function/deepFreeze/index.html +++ b/api/common/function/deepFreeze/index.html @@ -4,7 +4,7 @@ deepFreeze | API | Boost - + diff --git a/api/common/function/deepMerge/index.html b/api/common/function/deepMerge/index.html index 969c943cb..38621cc2b 100644 --- a/api/common/function/deepMerge/index.html +++ b/api/common/function/deepMerge/index.html @@ -4,7 +4,7 @@ deepMerge | API | Boost - + diff --git a/api/common/function/formatMs/index.html b/api/common/function/formatMs/index.html index dc36a6ab5..60d5a713f 100644 --- a/api/common/function/formatMs/index.html +++ b/api/common/function/formatMs/index.html @@ -4,7 +4,7 @@ formatMs | API | Boost - + diff --git a/api/common/function/instanceOf/index.html b/api/common/function/instanceOf/index.html index ff22b4594..9cf770163 100644 --- a/api/common/function/instanceOf/index.html +++ b/api/common/function/instanceOf/index.html @@ -4,7 +4,7 @@ instanceOf | API | Boost - + diff --git a/api/common/function/isEmpty/index.html b/api/common/function/isEmpty/index.html index cf0f22cd4..b26bfea56 100644 --- a/api/common/function/isEmpty/index.html +++ b/api/common/function/isEmpty/index.html @@ -4,7 +4,7 @@ isEmpty | API | Boost - + diff --git a/api/common/function/isFilePath/index.html b/api/common/function/isFilePath/index.html index 1b215ba43..d47b3e631 100644 --- a/api/common/function/isFilePath/index.html +++ b/api/common/function/isFilePath/index.html @@ -4,7 +4,7 @@ isFilePath | API | Boost - + diff --git a/api/common/function/isModuleName/index.html b/api/common/function/isModuleName/index.html index 1e7669b17..af67a35e8 100644 --- a/api/common/function/isModuleName/index.html +++ b/api/common/function/isModuleName/index.html @@ -4,7 +4,7 @@ isModuleName | API | Boost - + diff --git a/api/common/function/isObject/index.html b/api/common/function/isObject/index.html index 635d5f414..496f2ea84 100644 --- a/api/common/function/isObject/index.html +++ b/api/common/function/isObject/index.html @@ -4,7 +4,7 @@ isObject | API | Boost - + diff --git a/api/common/function/isPlainObject/index.html b/api/common/function/isPlainObject/index.html index b62062c7f..a2535f7df 100644 --- a/api/common/function/isPlainObject/index.html +++ b/api/common/function/isPlainObject/index.html @@ -4,7 +4,7 @@ isPlainObject | API | Boost - + diff --git a/api/common/function/toArray/index.html b/api/common/function/toArray/index.html index 6436df01c..a23332b5d 100644 --- a/api/common/function/toArray/index.html +++ b/api/common/function/toArray/index.html @@ -4,7 +4,7 @@ toArray | API | Boost - + diff --git a/api/common/index.html b/api/common/index.html index 53540d1b0..ebd8cf180 100644 --- a/api/common/index.html +++ b/api/common/index.html @@ -4,7 +4,7 @@ @boost/common | API | Boost - + diff --git a/api/common/interface/BugSetting/index.html b/api/common/interface/BugSetting/index.html index 185e2fa5f..d1773a675 100644 --- a/api/common/interface/BugSetting/index.html +++ b/api/common/interface/BugSetting/index.html @@ -4,7 +4,7 @@ BugSetting | API | Boost - + diff --git a/api/common/interface/DependencyMetaSetting/index.html b/api/common/interface/DependencyMetaSetting/index.html index bf053abd3..b2749716c 100644 --- a/api/common/interface/DependencyMetaSetting/index.html +++ b/api/common/interface/DependencyMetaSetting/index.html @@ -4,7 +4,7 @@ DependencyMetaSetting | API | Boost - + diff --git a/api/common/interface/Lookup/index.html b/api/common/interface/Lookup/index.html index 1cfcba17f..123e410ef 100644 --- a/api/common/interface/Lookup/index.html +++ b/api/common/interface/Lookup/index.html @@ -4,7 +4,7 @@ Lookup | API | Boost - + diff --git a/api/common/interface/MemoizeOptions/index.html b/api/common/interface/MemoizeOptions/index.html index 3e7c92514..95f68861f 100644 --- a/api/common/interface/MemoizeOptions/index.html +++ b/api/common/interface/MemoizeOptions/index.html @@ -4,7 +4,7 @@ MemoizeOptions | API | Boost - + diff --git a/api/common/interface/Optionable/index.html b/api/common/interface/Optionable/index.html index ec5d6a5fc..65ad9bd9a 100644 --- a/api/common/interface/Optionable/index.html +++ b/api/common/interface/Optionable/index.html @@ -4,7 +4,7 @@ Optionable | API | Boost - + diff --git a/api/common/interface/PackageGraphTree/index.html b/api/common/interface/PackageGraphTree/index.html index 183907d61..e25b43d6d 100644 --- a/api/common/interface/PackageGraphTree/index.html +++ b/api/common/interface/PackageGraphTree/index.html @@ -4,7 +4,7 @@ PackageGraphTree | API | Boost - + diff --git a/api/common/interface/PackageGraphTreeNode/index.html b/api/common/interface/PackageGraphTreeNode/index.html index 5e5ede4b0..ecd8acf83 100644 --- a/api/common/interface/PackageGraphTreeNode/index.html +++ b/api/common/interface/PackageGraphTreeNode/index.html @@ -4,7 +4,7 @@ PackageGraphTreeNode | API | Boost - + diff --git a/api/common/interface/PackageStructure/index.html b/api/common/interface/PackageStructure/index.html index ba496feec..2f9a9cb42 100644 --- a/api/common/interface/PackageStructure/index.html +++ b/api/common/interface/PackageStructure/index.html @@ -6,7 +6,7 @@ PackageStructure | API | Boost - + diff --git a/api/common/interface/Pathable/index.html b/api/common/interface/Pathable/index.html index bcf1db9a4..117be8b28 100644 --- a/api/common/interface/Pathable/index.html +++ b/api/common/interface/Pathable/index.html @@ -4,7 +4,7 @@ Pathable | API | Boost - + diff --git a/api/common/interface/PeerDependencyMetaSetting/index.html b/api/common/interface/PeerDependencyMetaSetting/index.html index 701014d99..5b8ea56ba 100644 --- a/api/common/interface/PeerDependencyMetaSetting/index.html +++ b/api/common/interface/PeerDependencyMetaSetting/index.html @@ -4,7 +4,7 @@ PeerDependencyMetaSetting | API | Boost - + diff --git a/api/common/interface/PeopleSetting/index.html b/api/common/interface/PeopleSetting/index.html index ed24ec84c..18ebaf52e 100644 --- a/api/common/interface/PeopleSetting/index.html +++ b/api/common/interface/PeopleSetting/index.html @@ -4,7 +4,7 @@ PeopleSetting | API | Boost - + diff --git a/api/common/interface/ProjectSearchOptions/index.html b/api/common/interface/ProjectSearchOptions/index.html index c44a3ca4f..64a83426f 100644 --- a/api/common/interface/ProjectSearchOptions/index.html +++ b/api/common/interface/ProjectSearchOptions/index.html @@ -4,7 +4,7 @@ ProjectSearchOptions | API | Boost - + diff --git a/api/common/interface/RepositorySetting/index.html b/api/common/interface/RepositorySetting/index.html index 524e3384c..05e8f7611 100644 --- a/api/common/interface/RepositorySetting/index.html +++ b/api/common/interface/RepositorySetting/index.html @@ -4,7 +4,7 @@ RepositorySetting | API | Boost - + diff --git a/api/common/interface/ResolvedLookup/index.html b/api/common/interface/ResolvedLookup/index.html index c0bb296ef..5f91e6a58 100644 --- a/api/common/interface/ResolvedLookup/index.html +++ b/api/common/interface/ResolvedLookup/index.html @@ -4,7 +4,7 @@ ResolvedLookup | API | Boost - + diff --git a/api/common/interface/Toolable/index.html b/api/common/interface/Toolable/index.html index 28760bdc4..28531ef5e 100644 --- a/api/common/interface/Toolable/index.html +++ b/api/common/interface/Toolable/index.html @@ -4,7 +4,7 @@ Toolable | API | Boost - + diff --git a/api/common/interface/TypeSetting/index.html b/api/common/interface/TypeSetting/index.html index eda656247..020ac631d 100644 --- a/api/common/interface/TypeSetting/index.html +++ b/api/common/interface/TypeSetting/index.html @@ -4,7 +4,7 @@ TypeSetting | API | Boost - + diff --git a/api/common/interface/WorkspaceMetadata/index.html b/api/common/interface/WorkspaceMetadata/index.html index 9e9fcef54..8e8ec9011 100644 --- a/api/common/interface/WorkspaceMetadata/index.html +++ b/api/common/interface/WorkspaceMetadata/index.html @@ -4,7 +4,7 @@ WorkspaceMetadata | API | Boost - + diff --git a/api/common/interface/WorkspacePackage/index.html b/api/common/interface/WorkspacePackage/index.html index 0f5b493d2..3acbd9504 100644 --- a/api/common/interface/WorkspacePackage/index.html +++ b/api/common/interface/WorkspacePackage/index.html @@ -4,7 +4,7 @@ WorkspacePackage | API | Boost - + diff --git a/api/common/namespace/json/index.html b/api/common/namespace/json/index.html index 993a9211b..c9450e686 100644 --- a/api/common/namespace/json/index.html +++ b/api/common/namespace/json/index.html @@ -4,7 +4,7 @@ json | API | Boost - + diff --git a/api/common/namespace/yaml/index.html b/api/common/namespace/yaml/index.html index cc0f7b036..d404e6c58 100644 --- a/api/common/namespace/yaml/index.html +++ b/api/common/namespace/yaml/index.html @@ -4,7 +4,7 @@ yaml | API | Boost - + diff --git a/api/config/class/Configuration/index.html b/api/config/class/Configuration/index.html index 5ecee0796..df226a8e9 100644 --- a/api/config/class/Configuration/index.html +++ b/api/config/class/Configuration/index.html @@ -4,7 +4,7 @@ Configuration | API | Boost - + diff --git a/api/config/function/createExtendsSchema/index.html b/api/config/function/createExtendsSchema/index.html index 38d9c0672..7ffb9e144 100644 --- a/api/config/function/createExtendsSchema/index.html +++ b/api/config/function/createExtendsSchema/index.html @@ -4,7 +4,7 @@ createExtendsSchema | API | Boost - + diff --git a/api/config/function/createOverridesSchema/index.html b/api/config/function/createOverridesSchema/index.html index 898939b2b..2ef048c8f 100644 --- a/api/config/function/createOverridesSchema/index.html +++ b/api/config/function/createOverridesSchema/index.html @@ -4,7 +4,7 @@ createOverridesSchema | API | Boost - + diff --git a/api/config/function/createPluginsSchema/index.html b/api/config/function/createPluginsSchema/index.html index 1f07763ce..b3dceff8c 100644 --- a/api/config/function/createPluginsSchema/index.html +++ b/api/config/function/createPluginsSchema/index.html @@ -4,7 +4,7 @@ createPluginsSchema | API | Boost - + diff --git a/api/config/function/getEnv/index.html b/api/config/function/getEnv/index.html index 117f632e8..e25f9ac5f 100644 --- a/api/config/function/getEnv/index.html +++ b/api/config/function/getEnv/index.html @@ -4,7 +4,7 @@ getEnv | API | Boost - + diff --git a/api/config/function/mergeArray/index.html b/api/config/function/mergeArray/index.html index 5dcb22a49..8a9f28229 100644 --- a/api/config/function/mergeArray/index.html +++ b/api/config/function/mergeArray/index.html @@ -4,7 +4,7 @@ mergeArray | API | Boost - + diff --git a/api/config/function/mergeExtends/index.html b/api/config/function/mergeExtends/index.html index 078c04266..b06a547ed 100644 --- a/api/config/function/mergeExtends/index.html +++ b/api/config/function/mergeExtends/index.html @@ -4,7 +4,7 @@ mergeExtends | API | Boost - + diff --git a/api/config/function/mergeObject/index.html b/api/config/function/mergeObject/index.html index 1f79f4184..7de4d9c35 100644 --- a/api/config/function/mergeObject/index.html +++ b/api/config/function/mergeObject/index.html @@ -4,7 +4,7 @@ mergeObject | API | Boost - + diff --git a/api/config/function/mergePlugins/index.html b/api/config/function/mergePlugins/index.html index d54b80eff..824cd37c3 100644 --- a/api/config/function/mergePlugins/index.html +++ b/api/config/function/mergePlugins/index.html @@ -4,7 +4,7 @@ mergePlugins | API | Boost - + diff --git a/api/config/function/overwrite/index.html b/api/config/function/overwrite/index.html index 04042fb8d..453b78431 100644 --- a/api/config/function/overwrite/index.html +++ b/api/config/function/overwrite/index.html @@ -4,7 +4,7 @@ overwrite | API | Boost - + diff --git a/api/config/index.html b/api/config/index.html index 1c86e0e5e..c31755502 100644 --- a/api/config/index.html +++ b/api/config/index.html @@ -4,7 +4,7 @@ @boost/config | API | Boost - + diff --git a/api/config/interface/BaseFinderOptions/index.html b/api/config/interface/BaseFinderOptions/index.html index b0471201c..b3e2fabbf 100644 --- a/api/config/interface/BaseFinderOptions/index.html +++ b/api/config/interface/BaseFinderOptions/index.html @@ -4,7 +4,7 @@ BaseFinderOptions | API | Boost - + diff --git a/api/config/interface/ConfigFile/index.html b/api/config/interface/ConfigFile/index.html index 37db0ecf7..9f0827cb7 100644 --- a/api/config/interface/ConfigFile/index.html +++ b/api/config/interface/ConfigFile/index.html @@ -4,7 +4,7 @@ ConfigFile | API | Boost - + diff --git a/api/config/interface/ConfigFinderOptions/index.html b/api/config/interface/ConfigFinderOptions/index.html index 9058baffe..fa994d455 100644 --- a/api/config/interface/ConfigFinderOptions/index.html +++ b/api/config/interface/ConfigFinderOptions/index.html @@ -4,7 +4,7 @@ ConfigFinderOptions | API | Boost - + diff --git a/api/config/interface/File/index.html b/api/config/interface/File/index.html index 9dac563fb..c9898d92f 100644 --- a/api/config/interface/File/index.html +++ b/api/config/interface/File/index.html @@ -4,7 +4,7 @@ File | API | Boost - + diff --git a/api/config/interface/IgnoreFile/index.html b/api/config/interface/IgnoreFile/index.html index 90fbec5a8..43931fff2 100644 --- a/api/config/interface/IgnoreFile/index.html +++ b/api/config/interface/IgnoreFile/index.html @@ -4,7 +4,7 @@ IgnoreFile | API | Boost - + diff --git a/api/config/interface/IgnoreFinderOptions/index.html b/api/config/interface/IgnoreFinderOptions/index.html index ebfb66aa4..66aadacf9 100644 --- a/api/config/interface/IgnoreFinderOptions/index.html +++ b/api/config/interface/IgnoreFinderOptions/index.html @@ -4,7 +4,7 @@ IgnoreFinderOptions | API | Boost - + diff --git a/api/config/interface/OverridesSettingItem/index.html b/api/config/interface/OverridesSettingItem/index.html index dbbbe0af0..c072d4445 100644 --- a/api/config/interface/OverridesSettingItem/index.html +++ b/api/config/interface/OverridesSettingItem/index.html @@ -4,7 +4,7 @@ OverridesSettingItem | API | Boost - + diff --git a/api/config/interface/ProcessedConfig/index.html b/api/config/interface/ProcessedConfig/index.html index b1c6b4ffd..0293b70b2 100644 --- a/api/config/interface/ProcessedConfig/index.html +++ b/api/config/interface/ProcessedConfig/index.html @@ -4,7 +4,7 @@ ProcessedConfig | API | Boost - + diff --git a/api/config/interface/ProcessorOptions/index.html b/api/config/interface/ProcessorOptions/index.html index 3634f8a48..61775dfc2 100644 --- a/api/config/interface/ProcessorOptions/index.html +++ b/api/config/interface/ProcessorOptions/index.html @@ -4,7 +4,7 @@ ProcessorOptions | API | Boost - + diff --git a/api/debug-test/function/mockDebugger/index.html b/api/debug-test/function/mockDebugger/index.html index 6a29db5d3..3f4d292b5 100644 --- a/api/debug-test/function/mockDebugger/index.html +++ b/api/debug-test/function/mockDebugger/index.html @@ -4,7 +4,7 @@ mockDebugger | API | Boost - + diff --git a/api/debug-test/index.html b/api/debug-test/index.html index de42e5832..338a347ca 100644 --- a/api/debug-test/index.html +++ b/api/debug-test/index.html @@ -4,7 +4,7 @@ @boost/debug/test | API | Boost - + diff --git a/api/debug/class/CrashReporter/index.html b/api/debug/class/CrashReporter/index.html index 75ed5a5a2..fd16c56ae 100644 --- a/api/debug/class/CrashReporter/index.html +++ b/api/debug/class/CrashReporter/index.html @@ -4,7 +4,7 @@ CrashReporter | API | Boost - + diff --git a/api/debug/function/createDebugger/index.html b/api/debug/function/createDebugger/index.html index 349b1eb6f..ebae7b9af 100644 --- a/api/debug/function/createDebugger/index.html +++ b/api/debug/function/createDebugger/index.html @@ -4,7 +4,7 @@ createDebugger | API | Boost - + diff --git a/api/debug/index.html b/api/debug/index.html index 69a9d4bfd..322363c4a 100644 --- a/api/debug/index.html +++ b/api/debug/index.html @@ -4,7 +4,7 @@ @boost/debug | API | Boost - + diff --git a/api/debug/interface/Debugger/index.html b/api/debug/interface/Debugger/index.html index 7eea1b029..d5390aad1 100644 --- a/api/debug/interface/Debugger/index.html +++ b/api/debug/interface/Debugger/index.html @@ -4,7 +4,7 @@ Debugger | API | Boost - + diff --git a/api/decorators/function/Bind/index.html b/api/decorators/function/Bind/index.html index 5adbca50e..4fb4b6bf8 100644 --- a/api/decorators/function/Bind/index.html +++ b/api/decorators/function/Bind/index.html @@ -4,7 +4,7 @@ Bind | API | Boost - + diff --git a/api/decorators/function/Debounce/index.html b/api/decorators/function/Debounce/index.html index 7ed97271a..d171fa036 100644 --- a/api/decorators/function/Debounce/index.html +++ b/api/decorators/function/Debounce/index.html @@ -4,7 +4,7 @@ Debounce | API | Boost - + diff --git a/api/decorators/function/Deprecate/index.html b/api/decorators/function/Deprecate/index.html index 7562b40e1..b6c0b8745 100644 --- a/api/decorators/function/Deprecate/index.html +++ b/api/decorators/function/Deprecate/index.html @@ -4,7 +4,7 @@ Deprecate | API | Boost - + diff --git a/api/decorators/function/Memoize/index.html b/api/decorators/function/Memoize/index.html index 9b6436681..413426921 100644 --- a/api/decorators/function/Memoize/index.html +++ b/api/decorators/function/Memoize/index.html @@ -4,7 +4,7 @@ Memoize | API | Boost - + diff --git a/api/decorators/function/Throttle/index.html b/api/decorators/function/Throttle/index.html index 053122d7f..504fc414c 100644 --- a/api/decorators/function/Throttle/index.html +++ b/api/decorators/function/Throttle/index.html @@ -4,7 +4,7 @@ Throttle | API | Boost - + diff --git a/api/decorators/index.html b/api/decorators/index.html index 4811fcef8..d31f94454 100644 --- a/api/decorators/index.html +++ b/api/decorators/index.html @@ -4,7 +4,7 @@ @boost/decorators | API | Boost - + diff --git a/api/decorators/interface/MemoizeOptions/index.html b/api/decorators/interface/MemoizeOptions/index.html index 49d40f2ee..2282e19ee 100644 --- a/api/decorators/interface/MemoizeOptions/index.html +++ b/api/decorators/interface/MemoizeOptions/index.html @@ -4,7 +4,7 @@ MemoizeOptions | API | Boost - + diff --git a/api/event/class/BailEvent/index.html b/api/event/class/BailEvent/index.html index 86ad7d826..0e7015c19 100644 --- a/api/event/class/BailEvent/index.html +++ b/api/event/class/BailEvent/index.html @@ -4,7 +4,7 @@ BailEvent | API | Boost - + diff --git a/api/event/class/BaseEvent/index.html b/api/event/class/BaseEvent/index.html index 8cc06c0f3..4792d154e 100644 --- a/api/event/class/BaseEvent/index.html +++ b/api/event/class/BaseEvent/index.html @@ -4,7 +4,7 @@ BaseEvent | API | Boost - + diff --git a/api/event/class/ConcurrentEvent/index.html b/api/event/class/ConcurrentEvent/index.html index b39a2e5a2..cf4804784 100644 --- a/api/event/class/ConcurrentEvent/index.html +++ b/api/event/class/ConcurrentEvent/index.html @@ -4,7 +4,7 @@ ConcurrentEvent | API | Boost - + diff --git a/api/event/class/Event/index.html b/api/event/class/Event/index.html index 9eee4299e..ef7508109 100644 --- a/api/event/class/Event/index.html +++ b/api/event/class/Event/index.html @@ -4,7 +4,7 @@ Event | API | Boost - + diff --git a/api/event/class/WaterfallEvent/index.html b/api/event/class/WaterfallEvent/index.html index 1179cb718..36481d963 100644 --- a/api/event/class/WaterfallEvent/index.html +++ b/api/event/class/WaterfallEvent/index.html @@ -4,7 +4,7 @@ WaterfallEvent | API | Boost - + diff --git a/api/event/index.html b/api/event/index.html index 1b984d998..97ac57fe6 100644 --- a/api/event/index.html +++ b/api/event/index.html @@ -4,7 +4,7 @@ @boost/event | API | Boost - + diff --git a/api/index.html b/api/index.html index a1a422d2d..9f281200a 100644 --- a/api/index.html +++ b/api/index.html @@ -4,7 +4,7 @@ Boost - + diff --git a/api/log-test/function/mockLogger/index.html b/api/log-test/function/mockLogger/index.html index 795d4afba..207edeef8 100644 --- a/api/log-test/function/mockLogger/index.html +++ b/api/log-test/function/mockLogger/index.html @@ -4,7 +4,7 @@ mockLogger | API | Boost - + diff --git a/api/log-test/index.html b/api/log-test/index.html index afbc90f03..0b6dd47ba 100644 --- a/api/log-test/index.html +++ b/api/log-test/index.html @@ -4,7 +4,7 @@ @boost/log/test | API | Boost - + diff --git a/api/log/class/ConsoleTransport/index.html b/api/log/class/ConsoleTransport/index.html index 5f294d247..60019204a 100644 --- a/api/log/class/ConsoleTransport/index.html +++ b/api/log/class/ConsoleTransport/index.html @@ -4,7 +4,7 @@ ConsoleTransport | API | Boost - + diff --git a/api/log/class/FileTransport/index.html b/api/log/class/FileTransport/index.html index 293ff171d..71022fbd6 100644 --- a/api/log/class/FileTransport/index.html +++ b/api/log/class/FileTransport/index.html @@ -4,7 +4,7 @@ FileTransport | API | Boost - + diff --git a/api/log/class/Logger/index.html b/api/log/class/Logger/index.html index 26bea1c99..ed35d08a1 100644 --- a/api/log/class/Logger/index.html +++ b/api/log/class/Logger/index.html @@ -4,7 +4,7 @@ Logger | API | Boost - + diff --git a/api/log/class/RotatingFileTransport/index.html b/api/log/class/RotatingFileTransport/index.html index c8a0e2996..af8f67a59 100644 --- a/api/log/class/RotatingFileTransport/index.html +++ b/api/log/class/RotatingFileTransport/index.html @@ -4,7 +4,7 @@ RotatingFileTransport | API | Boost - + diff --git a/api/log/class/StreamTransport/index.html b/api/log/class/StreamTransport/index.html index 54153f586..a8b28fcea 100644 --- a/api/log/class/StreamTransport/index.html +++ b/api/log/class/StreamTransport/index.html @@ -4,7 +4,7 @@ StreamTransport | API | Boost - + diff --git a/api/log/class/Transport/index.html b/api/log/class/Transport/index.html index ddadb4063..5916698bc 100644 --- a/api/log/class/Transport/index.html +++ b/api/log/class/Transport/index.html @@ -4,7 +4,7 @@ Transport | API | Boost - + diff --git a/api/log/function/createLogger/index.html b/api/log/function/createLogger/index.html index 88adf51b9..e3caac365 100644 --- a/api/log/function/createLogger/index.html +++ b/api/log/function/createLogger/index.html @@ -4,7 +4,7 @@ createLogger | API | Boost - + diff --git a/api/log/index.html b/api/log/index.html index dae11c508..1642e4bc8 100644 --- a/api/log/index.html +++ b/api/log/index.html @@ -4,7 +4,7 @@ @boost/log | API | Boost - + diff --git a/api/log/interface/FileTransportOptions/index.html b/api/log/interface/FileTransportOptions/index.html index 061a1c010..4d1243dcb 100644 --- a/api/log/interface/FileTransportOptions/index.html +++ b/api/log/interface/FileTransportOptions/index.html @@ -4,7 +4,7 @@ FileTransportOptions | API | Boost - + diff --git a/api/log/interface/LogItem/index.html b/api/log/interface/LogItem/index.html index 0be65c1be..e83441003 100644 --- a/api/log/interface/LogItem/index.html +++ b/api/log/interface/LogItem/index.html @@ -4,7 +4,7 @@ LogItem | API | Boost - + diff --git a/api/log/interface/LogOptions/index.html b/api/log/interface/LogOptions/index.html index 190b692e1..17e460388 100644 --- a/api/log/interface/LogOptions/index.html +++ b/api/log/interface/LogOptions/index.html @@ -4,7 +4,7 @@ LogOptions | API | Boost - + diff --git a/api/log/interface/Loggable/index.html b/api/log/interface/Loggable/index.html index b8d680967..34fe17b71 100644 --- a/api/log/interface/Loggable/index.html +++ b/api/log/interface/Loggable/index.html @@ -4,7 +4,7 @@ Loggable | API | Boost - + diff --git a/api/log/interface/LoggableWriter/index.html b/api/log/interface/LoggableWriter/index.html index 537fe163e..3fc680f1c 100644 --- a/api/log/interface/LoggableWriter/index.html +++ b/api/log/interface/LoggableWriter/index.html @@ -4,7 +4,7 @@ LoggableWriter | API | Boost - + diff --git a/api/log/interface/LoggerFunction/index.html b/api/log/interface/LoggerFunction/index.html index e3997b031..31fa6a67c 100644 --- a/api/log/interface/LoggerFunction/index.html +++ b/api/log/interface/LoggerFunction/index.html @@ -4,7 +4,7 @@ LoggerFunction | API | Boost - + diff --git a/api/log/interface/LoggerOptions/index.html b/api/log/interface/LoggerOptions/index.html index 8ca81b7c1..0c748966a 100644 --- a/api/log/interface/LoggerOptions/index.html +++ b/api/log/interface/LoggerOptions/index.html @@ -4,7 +4,7 @@ LoggerOptions | API | Boost - + diff --git a/api/log/interface/RotatingFileTransportOptions/index.html b/api/log/interface/RotatingFileTransportOptions/index.html index 7d3e4d069..576f2149f 100644 --- a/api/log/interface/RotatingFileTransportOptions/index.html +++ b/api/log/interface/RotatingFileTransportOptions/index.html @@ -4,7 +4,7 @@ RotatingFileTransportOptions | API | Boost - + diff --git a/api/log/interface/StreamTransportOptions/index.html b/api/log/interface/StreamTransportOptions/index.html index f8438b2b9..337470d63 100644 --- a/api/log/interface/StreamTransportOptions/index.html +++ b/api/log/interface/StreamTransportOptions/index.html @@ -4,7 +4,7 @@ StreamTransportOptions | API | Boost - + diff --git a/api/log/interface/TransportOptions/index.html b/api/log/interface/TransportOptions/index.html index ccbf4cf96..9d8d3df9d 100644 --- a/api/log/interface/TransportOptions/index.html +++ b/api/log/interface/TransportOptions/index.html @@ -4,7 +4,7 @@ TransportOptions | API | Boost - + diff --git a/api/log/interface/Transportable/index.html b/api/log/interface/Transportable/index.html index 5c7a29afe..46139a45d 100644 --- a/api/log/interface/Transportable/index.html +++ b/api/log/interface/Transportable/index.html @@ -4,7 +4,7 @@ Transportable | API | Boost - + diff --git a/api/log/interface/Writable/index.html b/api/log/interface/Writable/index.html index b33a61d06..587848624 100644 --- a/api/log/interface/Writable/index.html +++ b/api/log/interface/Writable/index.html @@ -4,7 +4,7 @@ Writable | API | Boost - + diff --git a/api/log/namespace/formats/index.html b/api/log/namespace/formats/index.html index f79be7656..25165d4df 100644 --- a/api/log/namespace/formats/index.html +++ b/api/log/namespace/formats/index.html @@ -4,7 +4,7 @@ formats | API | Boost - + diff --git a/api/module-loader/index.html b/api/module-loader/index.html index b672da28f..1bb155121 100644 --- a/api/module-loader/index.html +++ b/api/module-loader/index.html @@ -4,7 +4,7 @@ @boost/module/loader | API | Boost - + diff --git a/api/module/function/interopModule/index.html b/api/module/function/interopModule/index.html index 434253441..98c6bd368 100644 --- a/api/module/function/interopModule/index.html +++ b/api/module/function/interopModule/index.html @@ -4,7 +4,7 @@ interopModule | API | Boost - + diff --git a/api/module/function/registerExtensions/index.html b/api/module/function/registerExtensions/index.html index 2ff5ec40c..af8203994 100644 --- a/api/module/function/registerExtensions/index.html +++ b/api/module/function/registerExtensions/index.html @@ -4,7 +4,7 @@ registerExtensions | API | Boost - + diff --git a/api/module/function/requireModule/index.html b/api/module/function/requireModule/index.html index 8addd0e09..2920892bc 100644 --- a/api/module/function/requireModule/index.html +++ b/api/module/function/requireModule/index.html @@ -4,7 +4,7 @@ requireModule | API | Boost - + diff --git a/api/module/function/requireTSModule/index.html b/api/module/function/requireTSModule/index.html index ffec6e778..531d4d4e4 100644 --- a/api/module/function/requireTSModule/index.html +++ b/api/module/function/requireTSModule/index.html @@ -4,7 +4,7 @@ requireTSModule | API | Boost - + diff --git a/api/module/function/unregisterExtensions/index.html b/api/module/function/unregisterExtensions/index.html index c53c0b690..b1bf1e69b 100644 --- a/api/module/function/unregisterExtensions/index.html +++ b/api/module/function/unregisterExtensions/index.html @@ -4,7 +4,7 @@ unregisterExtensions | API | Boost - + diff --git a/api/module/index.html b/api/module/index.html index 7624d17b9..c49271360 100644 --- a/api/module/index.html +++ b/api/module/index.html @@ -4,7 +4,7 @@ @boost/module | API | Boost - + diff --git a/api/pipeline/class/AggregatedPipeline/index.html b/api/pipeline/class/AggregatedPipeline/index.html index d2d6003a9..2c40bc232 100644 --- a/api/pipeline/class/AggregatedPipeline/index.html +++ b/api/pipeline/class/AggregatedPipeline/index.html @@ -4,7 +4,7 @@ AggregatedPipeline | API | Boost - + diff --git a/api/pipeline/class/ConcurrentPipeline/index.html b/api/pipeline/class/ConcurrentPipeline/index.html index 179aa2eb2..65f485110 100644 --- a/api/pipeline/class/ConcurrentPipeline/index.html +++ b/api/pipeline/class/ConcurrentPipeline/index.html @@ -4,7 +4,7 @@ ConcurrentPipeline | API | Boost - + diff --git a/api/pipeline/class/Context/index.html b/api/pipeline/class/Context/index.html index cba8369c0..93769b1c2 100644 --- a/api/pipeline/class/Context/index.html +++ b/api/pipeline/class/Context/index.html @@ -4,7 +4,7 @@ Context | API | Boost - + diff --git a/api/pipeline/class/Monitor/index.html b/api/pipeline/class/Monitor/index.html index a4160dd20..fd0845f03 100644 --- a/api/pipeline/class/Monitor/index.html +++ b/api/pipeline/class/Monitor/index.html @@ -4,7 +4,7 @@ Monitor | API | Boost - + diff --git a/api/pipeline/class/ParallelPipeline/index.html b/api/pipeline/class/ParallelPipeline/index.html index bcd4474c4..d3031117a 100644 --- a/api/pipeline/class/ParallelPipeline/index.html +++ b/api/pipeline/class/ParallelPipeline/index.html @@ -4,7 +4,7 @@ ParallelPipeline | API | Boost - + diff --git a/api/pipeline/class/PooledPipeline/index.html b/api/pipeline/class/PooledPipeline/index.html index b7aebe6f0..d92f10965 100644 --- a/api/pipeline/class/PooledPipeline/index.html +++ b/api/pipeline/class/PooledPipeline/index.html @@ -4,7 +4,7 @@ PooledPipeline | API | Boost - + diff --git a/api/pipeline/class/Routine/index.html b/api/pipeline/class/Routine/index.html index a5dfc14d5..6acccf839 100644 --- a/api/pipeline/class/Routine/index.html +++ b/api/pipeline/class/Routine/index.html @@ -4,7 +4,7 @@ Routine | API | Boost - + diff --git a/api/pipeline/class/SerialPipeline/index.html b/api/pipeline/class/SerialPipeline/index.html index d9b220a10..2b9317b29 100644 --- a/api/pipeline/class/SerialPipeline/index.html +++ b/api/pipeline/class/SerialPipeline/index.html @@ -4,7 +4,7 @@ SerialPipeline | API | Boost - + diff --git a/api/pipeline/class/Task/index.html b/api/pipeline/class/Task/index.html index 9c0ed6e50..58bf644e0 100644 --- a/api/pipeline/class/Task/index.html +++ b/api/pipeline/class/Task/index.html @@ -4,7 +4,7 @@ Task | API | Boost - + diff --git a/api/pipeline/class/WaterfallPipeline/index.html b/api/pipeline/class/WaterfallPipeline/index.html index 77f09e5e9..e1ffafb30 100644 --- a/api/pipeline/class/WaterfallPipeline/index.html +++ b/api/pipeline/class/WaterfallPipeline/index.html @@ -4,7 +4,7 @@ WaterfallPipeline | API | Boost - + diff --git a/api/pipeline/class/WorkUnit/index.html b/api/pipeline/class/WorkUnit/index.html index 5b510d932..9540e9505 100644 --- a/api/pipeline/class/WorkUnit/index.html +++ b/api/pipeline/class/WorkUnit/index.html @@ -4,7 +4,7 @@ WorkUnit | API | Boost - + diff --git a/api/pipeline/index.html b/api/pipeline/index.html index 6b5e64258..e67082564 100644 --- a/api/pipeline/index.html +++ b/api/pipeline/index.html @@ -4,7 +4,7 @@ @boost/pipeline | API | Boost - + diff --git a/api/pipeline/interface/AggregatedResult/index.html b/api/pipeline/interface/AggregatedResult/index.html index 3ddb36de4..bbe416c03 100644 --- a/api/pipeline/interface/AggregatedResult/index.html +++ b/api/pipeline/interface/AggregatedResult/index.html @@ -4,7 +4,7 @@ AggregatedResult | API | Boost - + diff --git a/api/pipeline/interface/ExecuteCommandOptions/index.html b/api/pipeline/interface/ExecuteCommandOptions/index.html index 39072bcad..a0c763d04 100644 --- a/api/pipeline/interface/ExecuteCommandOptions/index.html +++ b/api/pipeline/interface/ExecuteCommandOptions/index.html @@ -4,7 +4,7 @@ ExecuteCommandOptions | API | Boost - + diff --git a/api/pipeline/interface/Hierarchical/index.html b/api/pipeline/interface/Hierarchical/index.html index a9d83814e..66246be65 100644 --- a/api/pipeline/interface/Hierarchical/index.html +++ b/api/pipeline/interface/Hierarchical/index.html @@ -4,7 +4,7 @@ Hierarchical | API | Boost - + diff --git a/api/pipeline/interface/PooledOptions/index.html b/api/pipeline/interface/PooledOptions/index.html index 69f92e5a0..c653eb0d1 100644 --- a/api/pipeline/interface/PooledOptions/index.html +++ b/api/pipeline/interface/PooledOptions/index.html @@ -4,7 +4,7 @@ PooledOptions | API | Boost - + diff --git a/api/pipeline/interface/Runnable/index.html b/api/pipeline/interface/Runnable/index.html index 436cfedea..7ed9ee319 100644 --- a/api/pipeline/interface/Runnable/index.html +++ b/api/pipeline/interface/Runnable/index.html @@ -4,7 +4,7 @@ Runnable | API | Boost - + diff --git a/api/plugin/class/Plugin/index.html b/api/plugin/class/Plugin/index.html index e6420cb7c..1eb8166a1 100644 --- a/api/plugin/class/Plugin/index.html +++ b/api/plugin/class/Plugin/index.html @@ -4,7 +4,7 @@ Plugin | API | Boost - + diff --git a/api/plugin/class/Registry/index.html b/api/plugin/class/Registry/index.html index f9f534abb..491959d29 100644 --- a/api/plugin/class/Registry/index.html +++ b/api/plugin/class/Registry/index.html @@ -4,7 +4,7 @@ Registry | API | Boost - + diff --git a/api/plugin/index.html b/api/plugin/index.html index 332305acb..80fc8e93c 100644 --- a/api/plugin/index.html +++ b/api/plugin/index.html @@ -4,7 +4,7 @@ @boost/plugin | API | Boost - + diff --git a/api/plugin/interface/Pluggable/index.html b/api/plugin/interface/Pluggable/index.html index fe54030d4..d41c32a4e 100644 --- a/api/plugin/interface/Pluggable/index.html +++ b/api/plugin/interface/Pluggable/index.html @@ -4,7 +4,7 @@ Pluggable | API | Boost - + diff --git a/api/plugin/interface/RegisterOptions/index.html b/api/plugin/interface/RegisterOptions/index.html index 53b743c69..ab92c5f9c 100644 --- a/api/plugin/interface/RegisterOptions/index.html +++ b/api/plugin/interface/RegisterOptions/index.html @@ -4,7 +4,7 @@ RegisterOptions | API | Boost - + diff --git a/api/plugin/interface/Registration/index.html b/api/plugin/interface/Registration/index.html index 2efdf2fb3..2778d4567 100644 --- a/api/plugin/interface/Registration/index.html +++ b/api/plugin/interface/Registration/index.html @@ -4,7 +4,7 @@ Registration | API | Boost - + diff --git a/api/plugin/interface/RegistryOptions/index.html b/api/plugin/interface/RegistryOptions/index.html index df8c5827f..5ed24fb85 100644 --- a/api/plugin/interface/RegistryOptions/index.html +++ b/api/plugin/interface/RegistryOptions/index.html @@ -4,7 +4,7 @@ RegistryOptions | API | Boost - + diff --git a/api/terminal/function/annotate/index.html b/api/terminal/function/annotate/index.html index 3fb1a723a..8bd5929c6 100644 --- a/api/terminal/function/annotate/index.html +++ b/api/terminal/function/annotate/index.html @@ -4,7 +4,7 @@ annotate | API | Boost - + diff --git a/api/terminal/function/calculateWidth/index.html b/api/terminal/function/calculateWidth/index.html index c2500382e..00e5ca353 100644 --- a/api/terminal/function/calculateWidth/index.html +++ b/api/terminal/function/calculateWidth/index.html @@ -4,7 +4,7 @@ calculateWidth | API | Boost - + diff --git a/api/terminal/function/hasAnsi/index.html b/api/terminal/function/hasAnsi/index.html index f1fddce27..0e79f2f91 100644 --- a/api/terminal/function/hasAnsi/index.html +++ b/api/terminal/function/hasAnsi/index.html @@ -4,7 +4,7 @@ hasAnsi | API | Boost - + diff --git a/api/terminal/function/link/index.html b/api/terminal/function/link/index.html index 880db8e99..82375b5d3 100644 --- a/api/terminal/function/link/index.html +++ b/api/terminal/function/link/index.html @@ -4,7 +4,7 @@ link | API | Boost - + diff --git a/api/terminal/function/sliceAnsi/index.html b/api/terminal/function/sliceAnsi/index.html index 6965d92d1..381a7a525 100644 --- a/api/terminal/function/sliceAnsi/index.html +++ b/api/terminal/function/sliceAnsi/index.html @@ -4,7 +4,7 @@ sliceAnsi | API | Boost - + diff --git a/api/terminal/function/stripAnsi/index.html b/api/terminal/function/stripAnsi/index.html index a47c36da2..a3356c2b7 100644 --- a/api/terminal/function/stripAnsi/index.html +++ b/api/terminal/function/stripAnsi/index.html @@ -4,7 +4,7 @@ stripAnsi | API | Boost - + diff --git a/api/terminal/function/truncate/index.html b/api/terminal/function/truncate/index.html index d92824cd3..7eddaaed0 100644 --- a/api/terminal/function/truncate/index.html +++ b/api/terminal/function/truncate/index.html @@ -4,7 +4,7 @@ truncate | API | Boost - + diff --git a/api/terminal/function/wrapAnsi/index.html b/api/terminal/function/wrapAnsi/index.html index a83e42d87..3c0d3ae4a 100644 --- a/api/terminal/function/wrapAnsi/index.html +++ b/api/terminal/function/wrapAnsi/index.html @@ -4,7 +4,7 @@ wrapAnsi | API | Boost - + diff --git a/api/terminal/index.html b/api/terminal/index.html index 24a27aae6..e00495839 100644 --- a/api/terminal/index.html +++ b/api/terminal/index.html @@ -4,7 +4,7 @@ @boost/terminal | API | Boost - + diff --git a/api/terminal/interface/WrapOptions/index.html b/api/terminal/interface/WrapOptions/index.html index 6fdbc0ad1..66de13bac 100644 --- a/api/terminal/interface/WrapOptions/index.html +++ b/api/terminal/interface/WrapOptions/index.html @@ -4,7 +4,7 @@ WrapOptions | API | Boost - + diff --git a/api/terminal/namespace/cursor/index.html b/api/terminal/namespace/cursor/index.html index 7c11c3a01..c9333be52 100644 --- a/api/terminal/namespace/cursor/index.html +++ b/api/terminal/namespace/cursor/index.html @@ -4,7 +4,7 @@ cursor | API | Boost - + diff --git a/api/terminal/namespace/screen/index.html b/api/terminal/namespace/screen/index.html index db2da9f19..7176f284c 100644 --- a/api/terminal/namespace/screen/index.html +++ b/api/terminal/namespace/screen/index.html @@ -4,7 +4,7 @@ screen | API | Boost - + diff --git a/api/translate/function/createTranslator/index.html b/api/translate/function/createTranslator/index.html index 759683f89..33303d8b5 100644 --- a/api/translate/function/createTranslator/index.html +++ b/api/translate/function/createTranslator/index.html @@ -4,7 +4,7 @@ createTranslator | API | Boost - + diff --git a/api/translate/index.html b/api/translate/index.html index 9ca9205d2..58d0cab0a 100644 --- a/api/translate/index.html +++ b/api/translate/index.html @@ -4,7 +4,7 @@ @boost/translate | API | Boost - + diff --git a/api/translate/interface/MessageOptions/index.html b/api/translate/interface/MessageOptions/index.html index 9156e458c..b2e99788c 100644 --- a/api/translate/interface/MessageOptions/index.html +++ b/api/translate/interface/MessageOptions/index.html @@ -4,7 +4,7 @@ MessageOptions | API | Boost - + diff --git a/api/translate/interface/Translator/index.html b/api/translate/interface/Translator/index.html index 665167aa4..a211a504b 100644 --- a/api/translate/interface/Translator/index.html +++ b/api/translate/interface/Translator/index.html @@ -4,7 +4,7 @@ Translator | API | Boost - + diff --git a/api/translate/interface/TranslatorOptions/index.html b/api/translate/interface/TranslatorOptions/index.html index 4c2aa6d7c..f95d98cdf 100644 --- a/api/translate/interface/TranslatorOptions/index.html +++ b/api/translate/interface/TranslatorOptions/index.html @@ -4,7 +4,7 @@ TranslatorOptions | API | Boost - + diff --git a/assets/js/2087399e.cae9cc8e.js b/assets/js/2087399e.224ef299.js similarity index 99% rename from assets/js/2087399e.cae9cc8e.js rename to assets/js/2087399e.224ef299.js index 3d8bac14a..ef5c5edf0 100644 --- a/assets/js/2087399e.cae9cc8e.js +++ b/assets/js/2087399e.224ef299.js @@ -1 +1 @@ -"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[5096],{8120:(e,s,o)=>{o.r(s),o.d(s,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>c});var i=o(1948),n=o(3460);const t={title:"5.0 migration",sidebar_label:"5.0"},l=void 0,r={id:"migrate/5.0",title:"5.0 migration",description:"Because boost is relatively stable (there has been no changes in months), this release is all about",source:"@site/docs/migrate/5.0.md",sourceDirName:"migrate",slug:"/migrate/5.0",permalink:"/docs/migrate/5.0",draft:!1,unlisted:!1,editUrl:"https://github.com/milesj/boost/edit/master/website/docs/migrate/5.0.md",tags:[],version:"current",frontMatter:{title:"5.0 migration",sidebar_label:"5.0"},sidebar:"docs",previous:{title:"4.0",permalink:"/docs/migrate/4.0"}},d={},c=[{value:"All packages",id:"all-packages",level:2},{value:"Migrated to ECMAScript modules (.mjs)",id:"migrated-to-ecmascript-modules-mjs",level:3},{value:"Package test utilities are now async",id:"package-test-utilities-are-now-async",level:3},{value:"@boost/common",id:"boostcommon",level:2},{value:"@boost/config",id:"boostconfig",level:2},{value:"@boost/cli",id:"boostcli",level:2},{value:"@boost/module",id:"boostmodule",level:2},{value:"@boost/plugin",id:"boostplugin",level:2},{value:"@boost/test-utils",id:"boosttest-utils",level:2},{value:"@boost/translate",id:"boosttranslate",level:2}];function a(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,n.M)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.p,{children:"Because boost is relatively stable (there has been no changes in months), this release is all about\nmigrating to ESM, and updating dependencies."}),"\n",(0,i.jsx)(s.h2,{id:"all-packages",children:"All packages"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Requires TypeScript v5 or greater."}),"\n",(0,i.jsx)(s.li,{children:"Dropped Node.js v14 support. Now requires v16.20 and above."}),"\n",(0,i.jsx)(s.li,{children:"Updated many dependencies to their latest major version."}),"\n",(0,i.jsx)(s.li,{children:"Migrated all test utilities from Jest to Vitest."}),"\n"]}),"\n",(0,i.jsxs)(s.h3,{id:"migrated-to-ecmascript-modules-mjs",children:["Migrated to ECMAScript modules (",(0,i.jsx)(s.code,{children:".mjs"}),")"]}),"\n",(0,i.jsxs)(s.p,{children:["We have finished our migration to modules, and all packages are now purely ESM, as we ship ",(0,i.jsx)(s.code,{children:".mjs"}),"\nfiles and utilize module-based ",(0,i.jsx)(s.code,{children:"exports"}),". The only exception to this is ",(0,i.jsx)(s.code,{children:"@boost/module"}),", which still\nships some ",(0,i.jsx)(s.code,{children:".cjs"})," files to support ",(0,i.jsx)(s.code,{children:"require()"})," augmentation."]}),"\n",(0,i.jsx)(s.p,{children:"With the migration to ESM, we also see the following benefits:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Increased performance and reduced memory usage."}),"\n",(0,i.jsx)(s.li,{children:"Packages are now easily tree-shakeable."}),"\n",(0,i.jsx)(s.li,{children:"They utilize more modern features and syntax."}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"package-test-utilities-are-now-async",children:"Package test utilities are now async"}),"\n",(0,i.jsxs)(s.p,{children:["Some test utilities in the ",(0,i.jsx)(s.code,{children:"/test"})," entry point for individual packages have been updated to be\nasync. This includes functions like ",(0,i.jsx)(s.code,{children:"mockDebugger"})," and ",(0,i.jsx)(s.code,{children:"mockLogger"}),". This change was made to support\nthe new Vitest testing framework."]}),"\n",(0,i.jsx)(s.h2,{id:"boostcommon",children:"@boost/common"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Migrated from ",(0,i.jsx)(s.code,{children:"resolve"})," to ",(0,i.jsx)(s.code,{children:"enhanced-resolve"})," for ",(0,i.jsx)(s.code,{children:"PathResolver"}),". This is to support\n",(0,i.jsx)(s.code,{children:"package.json"})," exports. We currently support the ",(0,i.jsx)(s.code,{children:"import"}),", ",(0,i.jsx)(s.code,{children:"require"}),", and ",(0,i.jsx)(s.code,{children:"node"})," conditions."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boostconfig",children:"@boost/config"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Loading of ",(0,i.jsx)(s.code,{children:".js"}),", ",(0,i.jsx)(s.code,{children:".cjs"}),", and ",(0,i.jsx)(s.code,{children:".mjs"})," files now utilizes dynamic ",(0,i.jsx)(s.code,{children:"import()"})," instead of ",(0,i.jsx)(s.code,{children:"require()"}),".\nThe configuration must also be the default export."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boostcli",children:"@boost/cli"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Upgraded to and now requires React v18."}),"\n",(0,i.jsx)(s.li,{children:"Upgraded to and now requires Ink v4. Now uses a WASM based Yoga engine."}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boostmodule",children:"@boost/module"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Migrate to the new Node.js hooks API, from the old loader API. Because of this, imports were\nchanged:","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"@boost/module/loader.mjs"})," -> ",(0,i.jsx)(s.code,{children:"@boost/module/register"})," (registers all hooks)"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"@boost/module/loader/typescript.mjs"})," -> ",(0,i.jsx)(s.code,{children:"@boost/module/hook-typescript"})," (the TypeScript hook\nitself)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boostplugin",children:"@boost/plugin"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Updated the ",(0,i.jsx)(s.code,{children:"Loader"})," to use dynamic ",(0,i.jsx)(s.code,{children:"import()"})," for loading modules, instead of our ",(0,i.jsx)(s.code,{children:"requireModule"}),"\nfunction from ",(0,i.jsx)(s.code,{children:"@boost/module"}),". This is to support both CJS and ESM files."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boosttest-utils",children:"@boost/test-utils"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Migrated from Jest to Vitest."}),"\n",(0,i.jsxs)(s.li,{children:["Removed the ",(0,i.jsx)(s.code,{children:"copyFixtureToMock"})," function."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boosttranslate",children:"@boost/translate"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Updated ",(0,i.jsx)(s.code,{children:"createTranslator"})," to be async."]}),"\n",(0,i.jsxs)(s.li,{children:["Added support for ",(0,i.jsx)(s.code,{children:".cjs"})," and ",(0,i.jsx)(s.code,{children:".mjs"})," files for translation resources."]}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,n.M)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},3460:(e,s,o)=>{o.d(s,{I:()=>r,M:()=>l});var i=o(6952);const n={},t=i.createContext(n);function l(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function r(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file +"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[5096],{8120:(e,s,o)=>{o.r(s),o.d(s,{assets:()=>d,contentTitle:()=>l,default:()=>h,frontMatter:()=>t,metadata:()=>r,toc:()=>c});var i=o(1948),n=o(3460);const t={title:"5.0 migration",sidebar_label:"5.0"},l=void 0,r={id:"migrate/5.0",title:"5.0 migration",description:"Because boost is relatively stable (there has been no changes in months), this release is all about",source:"@site/docs/migrate/5.0.md",sourceDirName:"migrate",slug:"/migrate/5.0",permalink:"/docs/migrate/5.0",draft:!1,unlisted:!1,editUrl:"https://github.com/milesj/boost/edit/master/website/docs/migrate/5.0.md",tags:[],version:"current",frontMatter:{title:"5.0 migration",sidebar_label:"5.0"},sidebar:"docs",previous:{title:"4.0",permalink:"/docs/migrate/4.0"}},d={},c=[{value:"All packages",id:"all-packages",level:2},{value:"Migrated to ECMAScript modules (.mjs)",id:"migrated-to-ecmascript-modules-mjs",level:3},{value:"Package test utilities are now async",id:"package-test-utilities-are-now-async",level:3},{value:"@boost/common",id:"boostcommon",level:2},{value:"@boost/config",id:"boostconfig",level:2},{value:"@boost/cli",id:"boostcli",level:2},{value:"@boost/module",id:"boostmodule",level:2},{value:"@boost/plugin",id:"boostplugin",level:2},{value:"@boost/test-utils",id:"boosttest-utils",level:2},{value:"@boost/translate",id:"boosttranslate",level:2}];function a(e){const s={code:"code",h2:"h2",h3:"h3",li:"li",p:"p",ul:"ul",...(0,n.M)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsx)(s.p,{children:"Because boost is relatively stable (there has been no changes in months), this release is all about\nmigrating to ESM, and updating dependencies."}),"\n",(0,i.jsx)(s.h2,{id:"all-packages",children:"All packages"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Requires TypeScript v5 or greater."}),"\n",(0,i.jsx)(s.li,{children:"Dropped Node.js v16 support. Now requires v18.12 and above."}),"\n",(0,i.jsx)(s.li,{children:"Updated many dependencies to their latest major version."}),"\n",(0,i.jsx)(s.li,{children:"Migrated all test utilities from Jest to Vitest."}),"\n"]}),"\n",(0,i.jsxs)(s.h3,{id:"migrated-to-ecmascript-modules-mjs",children:["Migrated to ECMAScript modules (",(0,i.jsx)(s.code,{children:".mjs"}),")"]}),"\n",(0,i.jsxs)(s.p,{children:["We have finished our migration to modules, and all packages are now purely ESM, as we ship ",(0,i.jsx)(s.code,{children:".mjs"}),"\nfiles and utilize module-based ",(0,i.jsx)(s.code,{children:"exports"}),". The only exception to this is ",(0,i.jsx)(s.code,{children:"@boost/module"}),", which still\nships some ",(0,i.jsx)(s.code,{children:".cjs"})," files to support ",(0,i.jsx)(s.code,{children:"require()"})," augmentation."]}),"\n",(0,i.jsx)(s.p,{children:"With the migration to ESM, we also see the following benefits:"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Increased performance and reduced memory usage."}),"\n",(0,i.jsx)(s.li,{children:"Packages are now easily tree-shakeable."}),"\n",(0,i.jsx)(s.li,{children:"They utilize more modern features and syntax."}),"\n"]}),"\n",(0,i.jsx)(s.h3,{id:"package-test-utilities-are-now-async",children:"Package test utilities are now async"}),"\n",(0,i.jsxs)(s.p,{children:["Some test utilities in the ",(0,i.jsx)(s.code,{children:"/test"})," entry point for individual packages have been updated to be\nasync. This includes functions like ",(0,i.jsx)(s.code,{children:"mockDebugger"})," and ",(0,i.jsx)(s.code,{children:"mockLogger"}),". This change was made to support\nthe new Vitest testing framework."]}),"\n",(0,i.jsx)(s.h2,{id:"boostcommon",children:"@boost/common"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Migrated from ",(0,i.jsx)(s.code,{children:"resolve"})," to ",(0,i.jsx)(s.code,{children:"enhanced-resolve"})," for ",(0,i.jsx)(s.code,{children:"PathResolver"}),". This is to support\n",(0,i.jsx)(s.code,{children:"package.json"})," exports. We currently support the ",(0,i.jsx)(s.code,{children:"import"}),", ",(0,i.jsx)(s.code,{children:"require"}),", and ",(0,i.jsx)(s.code,{children:"node"})," conditions."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boostconfig",children:"@boost/config"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Loading of ",(0,i.jsx)(s.code,{children:".js"}),", ",(0,i.jsx)(s.code,{children:".cjs"}),", and ",(0,i.jsx)(s.code,{children:".mjs"})," files now utilizes dynamic ",(0,i.jsx)(s.code,{children:"import()"})," instead of ",(0,i.jsx)(s.code,{children:"require()"}),".\nThe configuration must also be the default export."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boostcli",children:"@boost/cli"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Upgraded to and now requires React v18."}),"\n",(0,i.jsx)(s.li,{children:"Upgraded to and now requires Ink v4. Now uses a WASM based Yoga engine."}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boostmodule",children:"@boost/module"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Migrate to the new Node.js hooks API, from the old loader API. Because of this, imports were\nchanged:","\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"@boost/module/loader.mjs"})," -> ",(0,i.jsx)(s.code,{children:"@boost/module/register"})," (registers all hooks)"]}),"\n",(0,i.jsxs)(s.li,{children:[(0,i.jsx)(s.code,{children:"@boost/module/loader/typescript.mjs"})," -> ",(0,i.jsx)(s.code,{children:"@boost/module/hook-typescript"})," (the TypeScript hook\nitself)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boostplugin",children:"@boost/plugin"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Updated the ",(0,i.jsx)(s.code,{children:"Loader"})," to use dynamic ",(0,i.jsx)(s.code,{children:"import()"})," for loading modules, instead of our ",(0,i.jsx)(s.code,{children:"requireModule"}),"\nfunction from ",(0,i.jsx)(s.code,{children:"@boost/module"}),". This is to support both CJS and ESM files."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boosttest-utils",children:"@boost/test-utils"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsx)(s.li,{children:"Migrated from Jest to Vitest."}),"\n",(0,i.jsxs)(s.li,{children:["Removed the ",(0,i.jsx)(s.code,{children:"copyFixtureToMock"})," function."]}),"\n"]}),"\n",(0,i.jsx)(s.h2,{id:"boosttranslate",children:"@boost/translate"}),"\n",(0,i.jsxs)(s.ul,{children:["\n",(0,i.jsxs)(s.li,{children:["Updated ",(0,i.jsx)(s.code,{children:"createTranslator"})," to be async."]}),"\n",(0,i.jsxs)(s.li,{children:["Added support for ",(0,i.jsx)(s.code,{children:".cjs"})," and ",(0,i.jsx)(s.code,{children:".mjs"})," files for translation resources."]}),"\n"]})]})}function h(e={}){const{wrapper:s}={...(0,n.M)(),...e.components};return s?(0,i.jsx)(s,{...e,children:(0,i.jsx)(a,{...e})}):a(e)}},3460:(e,s,o)=>{o.d(s,{I:()=>r,M:()=>l});var i=o(6952);const n={},t=i.createContext(n);function l(e){const s=i.useContext(t);return i.useMemo((function(){return"function"==typeof e?e(s):{...s,...e}}),[s,e])}function r(e){let s;return s=e.disableParentContext?"function"==typeof e.components?e.components(n):e.components||n:l(e.components),i.createElement(t.Provider,{value:s},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4edc808e.292196cf.js b/assets/js/4edc808e.292196cf.js new file mode 100644 index 000000000..ce426f99c --- /dev/null +++ b/assets/js/4edc808e.292196cf.js @@ -0,0 +1 @@ +"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[9956],{6724:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(1948),r=s(3460),l=s(5392);const t={title:"Introduction",slug:"/"},o=void 0,c={id:"index",title:"Introduction",description:"A collection of type-safe cross-platform ESM packages for building robust server-side and",source:"@site/docs/index.mdx",sourceDirName:".",slug:"/",permalink:"/docs/",draft:!1,unlisted:!1,editUrl:"https://github.com/milesj/boost/edit/master/website/docs/index.mdx",tags:[],version:"current",frontMatter:{title:"Introduction",slug:"/"},sidebar:"docs",next:{title:"Arguments",permalink:"/docs/args"}},a={},d=[{value:"Packages",id:"packages",level:2},{value:"Requirements",id:"requirements",level:2},{value:"Environments",id:"environments",level:2}];function h(e){const n={a:"a",em:"em",h2:"h2",li:"li",p:"p",ul:"ul",...(0,r.M)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:["A collection of type-safe cross-platform ESM packages for building robust server-side ",(0,i.jsx)(n.em,{children:"and"}),"\nclient-side applications, packages, and tooling."]}),"\n",(0,i.jsx)(n.h2,{id:"packages",children:"Packages"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/args",children:"args"})," - Command line argument parsing and formatting."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/cli",children:"cli"})," - Command line program builder that renders with React and Ink."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/common",children:"common"})," - Common utilities for all packages."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/config",children:"config"})," - Configuration and ignore file loading."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/debug",children:"debug"})," - Debugging and crash reporting."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/decorators",children:"decorators"})," - Experimental decorators for common patterns."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/event",children:"event"})," - Sync or async based event emitters."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/log",children:"log"})," - Low-level system logging."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/module",children:"module"})," - Import custom file types at runtime."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/pipeline",children:"pipeline"})," - Serial or parallel based data pipelines."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/plugin",children:"plugin"})," - Plugin module registries and loading."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/terminal",children:"terminal"})," - Terminal/console utilities."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/translate",children:"translate"})," - Low-level file based message translations."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"requirements",children:"Requirements"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Linux, OSX, Windows"}),"\n",(0,i.jsx)(n.li,{children:"Node.js v18.12+ (for backend and tooling)"}),"\n",(0,i.jsx)(n.li,{children:"Edge, Chrome, Firefox (for frontend)"}),"\n",(0,i.jsx)(n.li,{children:"ESM only"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"environments",children:"Environments"}),"\n",(0,i.jsx)(n.p,{children:"Each Boost package is usable in one or many of the following environments. Each supported\nenvironment is denoted with a badge under the package's documentation."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(l.c,{type:"warning",children:"Backend"})," - Package is usable on the backend/server-side using Node.js."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(l.c,{type:"success",children:"Frontend"})," - Package is usable on the frontend/client-side using a web\nbrowser."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(l.c,{type:"primary",children:"Tooling"})," - Package is usable within a command line application or an npm\nmodule/package."]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.M)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},5392:(e,n,s)=>{s.d(n,{c:()=>r});var i=s(1948);function r(e){let{children:n,type:s}=e;return(0,i.jsx)("span",{className:"badge badge--"+s,children:n})}},3460:(e,n,s)=>{s.d(n,{I:()=>o,M:()=>t});var i=s(6952);const r={},l=i.createContext(r);function t(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/4edc808e.bfb350db.js b/assets/js/4edc808e.bfb350db.js deleted file mode 100644 index df554779d..000000000 --- a/assets/js/4edc808e.bfb350db.js +++ /dev/null @@ -1 +0,0 @@ -"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[9956],{6724:(e,n,s)=>{s.r(n),s.d(n,{assets:()=>a,contentTitle:()=>o,default:()=>u,frontMatter:()=>t,metadata:()=>c,toc:()=>d});var i=s(1948),r=s(3460),l=s(5392);const t={title:"Introduction",slug:"/"},o=void 0,c={id:"index",title:"Introduction",description:"A collection of type-safe cross-platform packages for building robust server-side and client-side",source:"@site/docs/index.mdx",sourceDirName:".",slug:"/",permalink:"/docs/",draft:!1,unlisted:!1,editUrl:"https://github.com/milesj/boost/edit/master/website/docs/index.mdx",tags:[],version:"current",frontMatter:{title:"Introduction",slug:"/"},sidebar:"docs",next:{title:"Arguments",permalink:"/docs/args"}},a={},d=[{value:"Packages",id:"packages",level:2},{value:"Requirements",id:"requirements",level:2},{value:"Environments",id:"environments",level:2}];function h(e){const n={a:"a",em:"em",h2:"h2",li:"li",p:"p",ul:"ul",...(0,r.M)(),...e.components};return(0,i.jsxs)(i.Fragment,{children:[(0,i.jsxs)(n.p,{children:["A collection of type-safe cross-platform packages for building robust server-side ",(0,i.jsx)(n.em,{children:"and"})," client-side\napplications, packages, and tooling."]}),"\n",(0,i.jsx)(n.h2,{id:"packages",children:"Packages"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/args",children:"args"})," - Command line argument parsing and formatting."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/cli",children:"cli"})," - Command line program builder that renders with React and Ink."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/common",children:"common"})," - Common utilities for all packages."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/config",children:"config"})," - Configuration and ignore file loading."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/debug",children:"debug"})," - Debugging and crash reporting."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/decorators",children:"decorators"})," - Experimental decorators for common patterns."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/event",children:"event"})," - Sync or async based event emitters."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/log",children:"log"})," - Low-level system logging."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/module",children:"module"})," - Import custom file types at runtime."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/pipeline",children:"pipeline"})," - Serial or parallel based data pipelines."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/plugin",children:"plugin"})," - Plugin module registries and loading."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/terminal",children:"terminal"})," - Terminal/console utilities."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(n.a,{href:"/docs/translate",children:"translate"})," - Low-level file based message translations."]}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"requirements",children:"Requirements"}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsx)(n.li,{children:"Linux, OSX, Windows"}),"\n",(0,i.jsx)(n.li,{children:"Node.js v16.20+ (for backend and tooling)"}),"\n",(0,i.jsx)(n.li,{children:"Edge, Chrome, Firefox (for frontend)"}),"\n"]}),"\n",(0,i.jsx)(n.h2,{id:"environments",children:"Environments"}),"\n",(0,i.jsx)(n.p,{children:"Each Boost package is usable in one or many of the following environments. Each supported\nenvironment is denoted with a badge under the package's documentation."}),"\n",(0,i.jsxs)(n.ul,{children:["\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(l.c,{type:"warning",children:"Backend"})," - Package is usable on the backend/server-side using Node.js."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(l.c,{type:"success",children:"Frontend"})," - Package is usable on the frontend/client-side using a web\nbrowser."]}),"\n",(0,i.jsxs)(n.li,{children:[(0,i.jsx)(l.c,{type:"primary",children:"Tooling"})," - Package is usable within a command line application or an npm\nmodule/package."]}),"\n"]})]})}function u(e={}){const{wrapper:n}={...(0,r.M)(),...e.components};return n?(0,i.jsx)(n,{...e,children:(0,i.jsx)(h,{...e})}):h(e)}},5392:(e,n,s)=>{s.d(n,{c:()=>r});var i=s(1948);function r(e){let{children:n,type:s}=e;return(0,i.jsx)("span",{className:"badge badge--"+s,children:n})}},3460:(e,n,s)=>{s.d(n,{I:()=>o,M:()=>t});var i=s(6952);const r={},l=i.createContext(r);function t(e){const n=i.useContext(l);return i.useMemo((function(){return"function"==typeof e?e(n):{...n,...e}}),[n,e])}function o(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:t(e.components),i.createElement(l.Provider,{value:n},e.children)}}}]); \ No newline at end of file diff --git a/assets/js/935f2afb.aa7e124d.js b/assets/js/935f2afb.4c24619f.js similarity index 70% rename from assets/js/935f2afb.aa7e124d.js rename to assets/js/935f2afb.4c24619f.js index b4c404fae..200bd08d8 100644 --- a/assets/js/935f2afb.aa7e124d.js +++ b/assets/js/935f2afb.4c24619f.js @@ -1 +1 @@ -"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[5696],{5988:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docs":[{"type":"link","label":"Introduction","href":"/docs/","docId":"index","unlisted":false},{"type":"category","label":"Packages","collapsed":false,"items":[{"type":"link","label":"Arguments","href":"/docs/args","docId":"args","unlisted":false},{"type":"category","label":"CLI","items":[{"type":"link","label":"Overview","href":"/docs/cli","docId":"cli","unlisted":false},{"type":"link","label":"Components","href":"/docs/cli/components","docId":"cli/components","unlisted":false},{"type":"link","label":"Prompts","href":"/docs/cli/prompts","docId":"cli/prompts","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"link","label":"Common utilities","href":"/docs/common","docId":"common","unlisted":false},{"type":"link","label":"Configuration","href":"/docs/config","docId":"config","unlisted":false},{"type":"link","label":"Crash reporting","href":"/docs/crash","docId":"crash","unlisted":false},{"type":"link","label":"Debugging","href":"/docs/debug","docId":"debug","unlisted":false},{"type":"link","label":"Decorators","href":"/docs/decorators","docId":"decorators","unlisted":false},{"type":"link","label":"Events","href":"/docs/event","docId":"event","unlisted":false},{"type":"link","label":"Logging","href":"/docs/log","docId":"log","unlisted":false},{"type":"link","label":"Modules","href":"/docs/module","docId":"module","unlisted":false},{"type":"link","label":"Pipelines","href":"/docs/pipeline","docId":"pipeline","unlisted":false},{"type":"link","label":"Plugins","href":"/docs/plugin","docId":"plugin","unlisted":false},{"type":"link","label":"Terminal utilities","href":"/docs/terminal","docId":"terminal","unlisted":false},{"type":"link","label":"Translations","href":"/docs/translate","docId":"translate","unlisted":false}],"collapsible":true},{"type":"category","label":"Migrations","collapsed":true,"items":[{"type":"link","label":"3.0","href":"/docs/migrate/3.0","docId":"migrate/3.0","unlisted":false},{"type":"link","label":"4.0","href":"/docs/migrate/4.0","docId":"migrate/4.0","unlisted":false},{"type":"link","label":"5.0","href":"/docs/migrate/5.0","docId":"migrate/5.0","unlisted":false}],"collapsible":true},{"type":"link","label":"Changelog","href":"https://github.com/milesj/boost/blob/master/CHANGELOG.md"}]},"docs":{"args":{"id":"args","title":"Arguments","description":"A type-safe and convention based argument parsing library, with strict validation checks.","sidebar":"docs"},"cli":{"id":"cli","title":"CLIs","description":"A type-safe and interactive command line program, powered by React and Ink. We also","sidebar":"docs"},"cli/components":{"id":"cli/components","title":"Components","description":"Boost provides the following components for use within your programs. All components can be imported","sidebar":"docs"},"cli/prompts":{"id":"cli/prompts","title":"Prompts","description":"Prompts are specialized React components for handling process.stdin input. All","sidebar":"docs"},"common":{"id":"common","title":"Common utilities","description":"A collection of common utilities, classes, and helpers.","sidebar":"docs"},"config":{"id":"config","title":"Configuration","description":"Powerful convention based finder, loader, and manager of both configuration and ignore files. Will","sidebar":"docs"},"crash":{"id":"crash","title":"Crash reporting","description":"Report important environmental information when an error occurs or a process crashes.","sidebar":"docs"},"debug":{"id":"debug","title":"Debugging","description":"Lightweight debugging. Wraps the amazing debug library to","sidebar":"docs"},"decorators":{"id":"decorators","title":"Decorators","description":"Experimental decorators for common patterns.","sidebar":"docs"},"event":{"id":"event","title":"Events","description":"A type-safe event system with multiple emitter patterns.","sidebar":"docs"},"index":{"id":"index","title":"Introduction","description":"A collection of type-safe cross-platform packages for building robust server-side and client-side","sidebar":"docs"},"internal/errors":{"id":"internal/errors","title":"Errors","description":"Each package should contain a scoped error class, created with the @boost/internal package\'s"},"log":{"id":"log","title":"Logging","description":"Lightweight level based logging system.","sidebar":"docs"},"migrate/3.0":{"id":"migrate/3.0","title":"3.0 migration","description":"All packages","sidebar":"docs"},"migrate/4.0":{"id":"migrate/4.0","title":"4.0 migration","description":"This is a rather simple release, as the APIs themselves are relatively stable. The biggest changes","sidebar":"docs"},"migrate/5.0":{"id":"migrate/5.0","title":"5.0 migration","description":"Because boost is relatively stable (there has been no changes in months), this release is all about","sidebar":"docs"},"module":{"id":"module","title":"Modules","description":"Load and resolve custom file types at runtime with a Node.js require replacement or","sidebar":"docs"},"pipeline":{"id":"pipeline","title":"Pipelines","description":"Pipe an input through a series of type-safe routines and tasks to produce an output, or simply, run","sidebar":"docs"},"plugin":{"id":"plugin","title":"Plugins","description":"Plugin based architecture that supports module loading, custom types, scopes, and more.","sidebar":"docs"},"terminal":{"id":"terminal","title":"Terminal utilities","description":"A collection of utilities for managing and interacting with a terminal.","sidebar":"docs"},"translate":{"id":"translate","title":"Translations","description":"Package and application level translations made easy.","sidebar":"docs"}}}')}}]); \ No newline at end of file +"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[5696],{5988:e=>{e.exports=JSON.parse('{"pluginId":"default","version":"current","label":"Next","banner":null,"badge":false,"noIndex":false,"className":"docs-version-current","isLast":true,"docsSidebars":{"docs":[{"type":"link","label":"Introduction","href":"/docs/","docId":"index","unlisted":false},{"type":"category","label":"Packages","collapsed":false,"items":[{"type":"link","label":"Arguments","href":"/docs/args","docId":"args","unlisted":false},{"type":"category","label":"CLI","items":[{"type":"link","label":"Overview","href":"/docs/cli","docId":"cli","unlisted":false},{"type":"link","label":"Components","href":"/docs/cli/components","docId":"cli/components","unlisted":false},{"type":"link","label":"Prompts","href":"/docs/cli/prompts","docId":"cli/prompts","unlisted":false}],"collapsed":true,"collapsible":true},{"type":"link","label":"Common utilities","href":"/docs/common","docId":"common","unlisted":false},{"type":"link","label":"Configuration","href":"/docs/config","docId":"config","unlisted":false},{"type":"link","label":"Crash reporting","href":"/docs/crash","docId":"crash","unlisted":false},{"type":"link","label":"Debugging","href":"/docs/debug","docId":"debug","unlisted":false},{"type":"link","label":"Decorators","href":"/docs/decorators","docId":"decorators","unlisted":false},{"type":"link","label":"Events","href":"/docs/event","docId":"event","unlisted":false},{"type":"link","label":"Logging","href":"/docs/log","docId":"log","unlisted":false},{"type":"link","label":"Modules","href":"/docs/module","docId":"module","unlisted":false},{"type":"link","label":"Pipelines","href":"/docs/pipeline","docId":"pipeline","unlisted":false},{"type":"link","label":"Plugins","href":"/docs/plugin","docId":"plugin","unlisted":false},{"type":"link","label":"Terminal utilities","href":"/docs/terminal","docId":"terminal","unlisted":false},{"type":"link","label":"Translations","href":"/docs/translate","docId":"translate","unlisted":false}],"collapsible":true},{"type":"category","label":"Migrations","collapsed":true,"items":[{"type":"link","label":"3.0","href":"/docs/migrate/3.0","docId":"migrate/3.0","unlisted":false},{"type":"link","label":"4.0","href":"/docs/migrate/4.0","docId":"migrate/4.0","unlisted":false},{"type":"link","label":"5.0","href":"/docs/migrate/5.0","docId":"migrate/5.0","unlisted":false}],"collapsible":true},{"type":"link","label":"Changelog","href":"https://github.com/milesj/boost/blob/master/CHANGELOG.md"}]},"docs":{"args":{"id":"args","title":"Arguments","description":"A type-safe and convention based argument parsing library, with strict validation checks.","sidebar":"docs"},"cli":{"id":"cli","title":"CLIs","description":"A type-safe and interactive command line program, powered by React and Ink. We also","sidebar":"docs"},"cli/components":{"id":"cli/components","title":"Components","description":"Boost provides the following components for use within your programs. All components can be imported","sidebar":"docs"},"cli/prompts":{"id":"cli/prompts","title":"Prompts","description":"Prompts are specialized React components for handling process.stdin input. All","sidebar":"docs"},"common":{"id":"common","title":"Common utilities","description":"A collection of common utilities, classes, and helpers.","sidebar":"docs"},"config":{"id":"config","title":"Configuration","description":"Powerful convention based finder, loader, and manager of both configuration and ignore files. Will","sidebar":"docs"},"crash":{"id":"crash","title":"Crash reporting","description":"Report important environmental information when an error occurs or a process crashes.","sidebar":"docs"},"debug":{"id":"debug","title":"Debugging","description":"Lightweight debugging. Wraps the amazing debug library to","sidebar":"docs"},"decorators":{"id":"decorators","title":"Decorators","description":"Experimental decorators for common patterns.","sidebar":"docs"},"event":{"id":"event","title":"Events","description":"A type-safe event system with multiple emitter patterns.","sidebar":"docs"},"index":{"id":"index","title":"Introduction","description":"A collection of type-safe cross-platform ESM packages for building robust server-side and","sidebar":"docs"},"internal/errors":{"id":"internal/errors","title":"Errors","description":"Each package should contain a scoped error class, created with the @boost/internal package\'s"},"log":{"id":"log","title":"Logging","description":"Lightweight level based logging system.","sidebar":"docs"},"migrate/3.0":{"id":"migrate/3.0","title":"3.0 migration","description":"All packages","sidebar":"docs"},"migrate/4.0":{"id":"migrate/4.0","title":"4.0 migration","description":"This is a rather simple release, as the APIs themselves are relatively stable. The biggest changes","sidebar":"docs"},"migrate/5.0":{"id":"migrate/5.0","title":"5.0 migration","description":"Because boost is relatively stable (there has been no changes in months), this release is all about","sidebar":"docs"},"module":{"id":"module","title":"Modules","description":"Load and resolve custom file types at runtime with a Node.js require replacement or","sidebar":"docs"},"pipeline":{"id":"pipeline","title":"Pipelines","description":"Pipe an input through a series of type-safe routines and tasks to produce an output, or simply, run","sidebar":"docs"},"plugin":{"id":"plugin","title":"Plugins","description":"Plugin based architecture that supports module loading, custom types, scopes, and more.","sidebar":"docs"},"terminal":{"id":"terminal","title":"Terminal utilities","description":"A collection of utilities for managing and interacting with a terminal.","sidebar":"docs"},"translate":{"id":"translate","title":"Translations","description":"Package and application level translations made easy.","sidebar":"docs"}}}')}}]); \ No newline at end of file diff --git a/assets/js/c9be295d.eb6ce5f2.js b/assets/js/c9be295d.caaa6d86.js similarity index 99% rename from assets/js/c9be295d.eb6ce5f2.js rename to assets/js/c9be295d.caaa6d86.js index 56e104030..44ba5c876 100644 --- a/assets/js/c9be295d.eb6ce5f2.js +++ b/assets/js/c9be295d.caaa6d86.js @@ -1 +1 @@ -"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8708],{3888:e=>{e.exports=JSON.parse('[{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":1,"name":"@boost/args","variant":"declaration","kind":2,"flags":{},"children":[{"id":147,"name":"ParseError","variant":"declaration","kind":128,"flags":{},"children":[{"id":148,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/args/src/ParseError.ts","line":6,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L6"}],"signatures":[{"id":149,"name":"new ParseError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/args/src/ParseError.ts","line":6,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L6"}],"parameters":[{"id":150,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":151,"name":"arg","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":152,"name":"index","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":147,"name":"ParseError","package":"@boost/args"},"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}},{"id":153,"name":"arg","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/src/ParseError.ts","line":2,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L2"}],"type":{"type":"intrinsic","name":"string"}},{"id":154,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/src/ParseError.ts","line":4,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L4"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","children":[148]},{"title":"Properties","children":[153,154]}],"sources":[{"fileName":"packages/args/src/ParseError.ts","line":1,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L1"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}],"permalink":"/api/args/class/ParseError","nextId":335},{"id":335,"name":"ValidationError","variant":"declaration","kind":128,"flags":{},"children":[{"id":336,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/args/src/ValidationError.ts","line":6,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ValidationError.ts#L6"}],"signatures":[{"id":337,"name":"new ValidationError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/args/src/ValidationError.ts","line":6,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ValidationError.ts#L6"}],"parameters":[{"id":338,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":339,"name":"option","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"}],"type":{"type":"reference","target":335,"name":"ValidationError","package":"@boost/args"},"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}},{"id":340,"name":"option","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/src/ValidationError.ts","line":4,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ValidationError.ts#L4"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Constructors","children":[336]},{"title":"Properties","children":[340]}],"sources":[{"fileName":"packages/args/src/ValidationError.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ValidationError.ts#L3"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}],"permalink":"/api/args/class/ValidationError","previousId":147,"nextId":137},{"id":225,"name":"Arg","variant":"declaration","kind":256,"flags":{},"children":[{"id":226,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L160"}],"type":{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}},{"id":236,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":214,"name":"Config.deprecated"}},{"id":237,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":215,"name":"Config.description"}},{"id":227,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":228,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":229,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":230,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}}]}}},{"id":238,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":216,"name":"Config.hidden"}},{"id":231,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"}},{"id":232,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":233,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":234,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":235,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[226,236,237,227,238,231,232]}],"sources":[{"fileName":"packages/args/src/types.ts","line":150,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L150"}],"typeParameters":[{"id":239,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"extendedTypes":[{"type":"reference","target":213,"name":"Config","package":"@boost/args"}],"extendedBy":[{"type":"reference","target":240,"name":"Option"},{"type":"reference","target":303,"name":"Param"}],"permalink":"/api/args/interface/Arg","previousId":155,"nextId":191},{"id":191,"name":"Arguments","variant":"declaration","kind":256,"flags":{},"children":[{"id":192,"name":"command","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current running command and sub-commads. Is an array split on \\":\\"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L92"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":193,"name":"errors","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of errors detected during argument parsing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":94,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L94"}],"type":{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}},{"id":194,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of options to their values passed on the command line (or their default)."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":96,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L96"}],"type":{"type":"reference","target":198,"name":"O","package":"@boost/args","qualifiedName":"Arguments.O","refersToTypeParameter":true}},{"id":195,"name":"params","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of parameter values passed on the command line."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L98"}],"type":{"type":"reference","target":175,"typeArguments":[{"type":"reference","target":199,"name":"P","package":"@boost/args","qualifiedName":"Arguments.P","refersToTypeParameter":true}],"name":"MapParamType","package":"@boost/args"}},{"id":196,"name":"rest","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of arguments that appear after \\"--\\" on the command line."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":100,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L100"}],"type":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}},{"id":197,"name":"unknown","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of unconfigured options to string values."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":102,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L102"}],"type":{"type":"reference","target":169,"name":"UnknownOptionMap","package":"@boost/args"}}],"groups":[{"title":"Properties","children":[192,193,194,195,196,197]}],"sources":[{"fileName":"packages/args/src/types.ts","line":90,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L90"}],"typeParameters":[{"id":198,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":199,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}],"permalink":"/api/args/interface/Arguments","previousId":225,"nextId":320},{"id":320,"name":"Category","variant":"declaration","kind":256,"flags":{},"children":[{"id":321,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":205,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L205"}],"type":{"type":"intrinsic","name":"string"}},{"id":322,"name":"weight","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":206,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L206"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[321,322]}],"sources":[{"fileName":"packages/args/src/types.ts","line":204,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L204"}],"permalink":"/api/args/interface/Category","previousId":191,"nextId":217},{"id":217,"name":"Command","variant":"declaration","kind":256,"flags":{},"children":[{"id":218,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":137,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L137"}],"type":{"type":"intrinsic","name":"string"}},{"id":220,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":214,"name":"Config.deprecated"}},{"id":221,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":215,"name":"Config.description"}},{"id":222,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":216,"name":"Config.hidden"}},{"id":219,"name":"usage","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Define one or many usage examples to display in the help menu."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":139,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L139"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"groups":[{"title":"Properties","children":[218,220,221,222,219]}],"sources":[{"fileName":"packages/args/src/types.ts","line":135,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L135"}],"extendedTypes":[{"type":"reference","target":213,"name":"Config","package":"@boost/args"}],"permalink":"/api/args/interface/Command","previousId":320,"nextId":213},{"id":213,"name":"Config","variant":"declaration","kind":256,"flags":{},"children":[{"id":214,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":215,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"}},{"id":216,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[214,215,216]}],"sources":[{"fileName":"packages/args/src/types.ts","line":126,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L126"}],"extendedBy":[{"type":"reference","target":217,"name":"Command"},{"type":"reference","target":225,"name":"Arg"}],"permalink":"/api/args/interface/Config","previousId":217,"nextId":295},{"id":295,"name":"Flag","variant":"declaration","kind":256,"flags":{},"children":[{"id":297,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L171"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.category"}},{"id":296,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":193,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L193"}],"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","target":-1,"name":"Omit.default"}},{"id":300,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.deprecated"}},{"id":301,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.description"}},{"id":302,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.hidden"}},{"id":298,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":173,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L173"}],"type":{"type":"reference","target":334,"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.short"}},{"id":299,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"literal","value":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.type"}}],"groups":[{"title":"Properties","children":[297,296,300,301,302,298,299]}],"sources":[{"fileName":"packages/args/src/types.ts","line":192,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L192"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":240,"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Option","package":"@boost/args"},{"type":"union","types":[{"type":"literal","value":"format"},{"type":"literal","value":"validate"}]}],"name":"Omit","package":"typescript"}],"permalink":"/api/args/interface/Flag","previousId":213,"nextId":276},{"id":276,"name":"MultipleOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":277,"name":"arity","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error unless the list of values satisfy this required length."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":186,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L186"}],"type":{"type":"intrinsic","name":"number"}},{"id":280,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L171"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":241,"name":"Option.category"}},{"id":278,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":187,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L187"}],"type":{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true},"overwrites":{"type":"reference","target":243,"name":"Option.default"}},{"id":291,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":253,"name":"Option.deprecated"}},{"id":292,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":254,"name":"Option.description"}},{"id":282,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":283,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":284,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":285,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":244,"name":"Option.format"}},{"id":293,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":255,"name":"Option.hidden"}},{"id":279,"name":"multiple","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow multiple values to be passed."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":189,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L189"}],"type":{"type":"literal","value":true}},{"id":281,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":173,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L173"}],"type":{"type":"reference","target":334,"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":242,"name":"Option.short"}},{"id":286,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":248,"name":"Option.type"}},{"id":287,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":288,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":289,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":290,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":249,"name":"Option.validate"}}],"groups":[{"title":"Properties","children":[277,280,278,291,292,282,293,279,281,286,287]}],"sources":[{"fileName":"packages/args/src/types.ts","line":184,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L184"}],"typeParameters":[{"id":294,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":164,"name":"ListType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":240,"typeArguments":[{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}],"name":"Option","package":"@boost/args"}],"permalink":"/api/args/interface/MultipleOption","previousId":295,"nextId":240},{"id":240,"name":"Option","variant":"declaration","kind":256,"flags":{},"children":[{"id":241,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L171"}],"type":{"type":"intrinsic","name":"string"}},{"id":243,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L160"}],"type":{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":226,"name":"Arg.default"}},{"id":253,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":236,"name":"Arg.deprecated"}},{"id":254,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":237,"name":"Arg.description"}},{"id":244,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":245,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":246,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":247,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":227,"name":"Arg.format"}},{"id":255,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":238,"name":"Arg.hidden"}},{"id":242,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":173,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L173"}],"type":{"type":"reference","target":334,"name":"ShortOptionName","package":"@boost/args"}},{"id":248,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":231,"name":"Arg.type"}},{"id":249,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":250,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":251,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":252,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":232,"name":"Arg.validate"}}],"groups":[{"title":"Properties","children":[241,243,253,254,244,255,242,248,249]}],"sources":[{"fileName":"packages/args/src/types.ts","line":169,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L169"}],"typeParameters":[{"id":256,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":167,"name":"ValueType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":225,"typeArguments":[{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}],"name":"Arg","package":"@boost/args"}],"extendedBy":[{"type":"reference","target":257,"name":"SingleOption"},{"type":"reference","target":276,"name":"MultipleOption"}],"permalink":"/api/args/interface/Option","previousId":276,"nextId":303},{"id":303,"name":"Param","variant":"declaration","kind":256,"flags":{},"children":[{"id":306,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L160"}],"type":{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":226,"name":"Arg.default"}},{"id":316,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":236,"name":"Arg.deprecated"}},{"id":317,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":237,"name":"Arg.description"}},{"id":307,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":308,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":309,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":310,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":227,"name":"Arg.format"}},{"id":318,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":238,"name":"Arg.hidden"}},{"id":304,"name":"label","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Informational label to display in terminal output."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":198,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L198"}],"type":{"type":"intrinsic","name":"string"}},{"id":305,"name":"required","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the param is required or not. If required and not passed, the\\nparser will throw an error. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":201,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L201"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":311,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":231,"name":"Arg.type"}},{"id":312,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":313,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":314,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":315,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":232,"name":"Arg.validate"}}],"groups":[{"title":"Properties","children":[306,316,317,307,318,304,305,311,312]}],"sources":[{"fileName":"packages/args/src/types.ts","line":196,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L196"}],"typeParameters":[{"id":319,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":225,"typeArguments":[{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}],"name":"Arg","package":"@boost/args"}],"permalink":"/api/args/interface/Param","previousId":240,"nextId":204},{"id":204,"name":"ParserOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":205,"name":"commands","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of valid commands. Sub-commands should be denoted with \\":\\"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L117"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"reference","target":181,"name":"CommandChecker","package":"@boost/args"}]}},{"id":208,"name":"loose","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Enable loose mode parsing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":107,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L107"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":201,"name":"ParserSettings.loose"}},{"id":206,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of options to their type and configurations."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L119"}],"type":{"type":"reference","target":179,"typeArguments":[{"type":"reference","target":211,"name":"O","package":"@boost/args","qualifiedName":"ParserOptions.O","refersToTypeParameter":true}],"name":"MapOptionConfig","package":"@boost/args"}},{"id":207,"name":"params","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of param configurations (in order)."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L121"}],"type":{"type":"reference","target":173,"typeArguments":[{"type":"reference","target":212,"name":"P","package":"@boost/args","qualifiedName":"ParserOptions.P","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}},{"id":209,"name":"unknown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be passed. Will be placed in a special "},{"kind":"code","text":"`unknown`"},{"kind":"text","text":" object."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":109,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L109"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":202,"name":"ParserSettings.unknown"}},{"id":210,"name":"variadic","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be passed. Will be accumlated after configured params."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":111,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L111"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":203,"name":"ParserSettings.variadic"}}],"groups":[{"title":"Properties","children":[205,208,206,207,209,210]}],"sources":[{"fileName":"packages/args/src/types.ts","line":114,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L114"}],"typeParameters":[{"id":211,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":212,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":200,"name":"ParserSettings","package":"@boost/args"}],"permalink":"/api/args/interface/ParserOptions","previousId":303,"nextId":200},{"id":200,"name":"ParserSettings","variant":"declaration","kind":256,"flags":{},"children":[{"id":201,"name":"loose","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Enable loose mode parsing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":107,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L107"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":202,"name":"unknown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be passed. Will be placed in a special "},{"kind":"code","text":"`unknown`"},{"kind":"text","text":" object."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":109,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L109"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":203,"name":"variadic","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be passed. Will be accumlated after configured params."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":111,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L111"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[201,202,203]}],"sources":[{"fileName":"packages/args/src/types.ts","line":105,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L105"}],"extendedBy":[{"type":"reference","target":204,"name":"ParserOptions"}],"permalink":"/api/args/interface/ParserSettings","previousId":204,"nextId":257},{"id":257,"name":"SingleOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":261,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L171"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":241,"name":"Option.category"}},{"id":258,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whitelist of acceptable values."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":178,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L178"}],"type":{"type":"array","elementType":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}},{"id":259,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"When found in an option group, increment the value for each occurrence. _(Numbers only)_"}]},"sources":[{"fileName":"packages/args/src/types.ts","line":180,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L180"}],"type":{"type":"conditional","checkType":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"number"},"trueType":{"type":"literal","value":true},"falseType":{"type":"intrinsic","name":"never"}}},{"id":260,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":181,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L181"}],"type":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true},"overwrites":{"type":"reference","target":243,"name":"Option.default"}},{"id":272,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":253,"name":"Option.deprecated"}},{"id":273,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":254,"name":"Option.description"}},{"id":263,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":264,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":265,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":266,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":244,"name":"Option.format"}},{"id":274,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":255,"name":"Option.hidden"}},{"id":262,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":173,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L173"}],"type":{"type":"reference","target":334,"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":242,"name":"Option.short"}},{"id":267,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":248,"name":"Option.type"}},{"id":268,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":269,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":270,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":271,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":249,"name":"Option.validate"}}],"groups":[{"title":"Properties","children":[261,258,259,260,272,273,263,274,262,267,268]}],"sources":[{"fileName":"packages/args/src/types.ts","line":176,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L176"}],"typeParameters":[{"id":275,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":165,"name":"ScalarType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":240,"typeArguments":[{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}],"name":"Option","package":"@boost/args"}],"permalink":"/api/args/interface/SingleOption","previousId":200,"nextId":170},{"id":170,"name":"AliasMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":19,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L19"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript"},"permalink":"/api/args#AliasMap","previousId":257,"nextId":163},{"id":163,"name":"ArgList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L5"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"permalink":"/api/args#ArgList","previousId":170,"nextId":123},{"id":123,"name":"ArgsErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/ArgsError.ts","line":35,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ArgsError.ts#L35"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/args/src/ArgsError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/args","preferValues":true}}},"permalink":"/api/args#ArgsErrorCode","previousId":163,"nextId":162},{"id":162,"name":"Argv","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L3"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"permalink":"/api/args#Argv","previousId":123,"nextId":181},{"id":181,"name":"CommandChecker","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":86,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L86"}],"type":{"type":"reflection","declaration":{"id":182,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":86,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L86"}],"signatures":[{"id":183,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":184,"name":"arg","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}]}},"permalink":"/api/args#CommandChecker","previousId":162,"nextId":185},{"id":185,"name":"ContextFactory","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":88,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L88"}],"type":{"type":"reflection","declaration":{"id":186,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":88,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L88"}],"signatures":[{"id":187,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":189,"name":"arg","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":190,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":162,"name":"Argv","package":"@boost/args"}}],"type":{"type":"union","types":[{"type":"reference","target":204,"typeArguments":[{"type":"reflection","declaration":{"id":188,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":88,"character":72,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L88"}]}}],"name":"ParserOptions","package":"@boost/args"},{"type":"intrinsic","name":"undefined"}]}}]}},"permalink":"/api/args#ContextFactory","previousId":181,"nextId":223},{"id":223,"name":"InferArgType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":144,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L144"}],"typeParameters":[{"id":224,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":224,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"boolean"},"trueType":{"type":"literal","value":"boolean"},"falseType":{"type":"conditional","checkType":{"type":"reference","target":224,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"intrinsic","name":"number"}]},"trueType":{"type":"literal","value":"number"},"falseType":{"type":"literal","value":"string"}}},"permalink":"/api/args#InferArgType","previousId":185,"nextId":177},{"id":177,"name":"InferOptionConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Determine option based on type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":75,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L75"}],"typeParameters":[{"id":178,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"boolean"},"trueType":{"type":"reference","target":295,"name":"Flag","package":"@boost/args"},"falseType":{"type":"conditional","checkType":{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"trueType":{"type":"reference","target":276,"typeArguments":[{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true}],"name":"MultipleOption","package":"@boost/args"},"falseType":{"type":"conditional","checkType":{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"}]},"trueType":{"type":"reference","target":257,"typeArguments":[{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true}],"name":"SingleOption","package":"@boost/args"},"falseType":{"type":"intrinsic","name":"never"}}}},"permalink":"/api/args#InferOptionConfig","previousId":223,"nextId":171},{"id":171,"name":"InferParamConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Determine option based on type. Only primitives are allowed."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":22,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L22"}],"typeParameters":[{"id":172,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":172,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"},"trueType":{"type":"reference","target":303,"typeArguments":[{"type":"reference","target":172,"name":"T","package":"@boost/args","refersToTypeParameter":true}],"name":"Param","package":"@boost/args"},"falseType":{"type":"intrinsic","name":"never"}},"permalink":"/api/args#InferParamConfig","previousId":177,"nextId":164},{"id":164,"name":"ListType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":7,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L7"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"permalink":"/api/args#ListType","previousId":171,"nextId":333},{"id":333,"name":"LongOptionName","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Option name without leading \\"--\\"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":226,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L226"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/args#LongOptionName","previousId":164,"nextId":179},{"id":179,"name":"MapOptionConfig","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":84,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L84"}],"typeParameters":[{"id":180,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"type":{"type":"mapped","parameter":"K","parameterType":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","target":180,"name":"T","package":"@boost/args","refersToTypeParameter":true}},"templateType":{"type":"reference","target":177,"typeArguments":[{"type":"indexedAccess","indexType":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"K"},"name":"K","package":"@boost/args","refersToTypeParameter":true},"objectType":{"type":"reference","target":180,"name":"T","package":"@boost/args","refersToTypeParameter":true}}],"name":"InferOptionConfig","package":"@boost/args"}},"permalink":"/api/args#MapOptionConfig","previousId":333,"nextId":173},{"id":173,"name":"MapParamConfig","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":26,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L26"}],"typeParameters":[{"id":174,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}}}],"type":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"},{"type":"inferred","name":"D"},{"type":"inferred","name":"E"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"D"},"name":"D","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"E"},"name":"E","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"},{"type":"inferred","name":"D"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"D"},"name":"D","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"},"trueType":{"type":"array","elementType":{"type":"reference","target":303,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Param","package":"@boost/args"}},"falseType":{"type":"intrinsic","name":"never"}}}}}}},"permalink":"/api/args#MapParamConfig","previousId":179,"nextId":175},{"id":175,"name":"MapParamType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":54,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L54"}],"typeParameters":[{"id":176,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}}}],"type":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"},{"type":"inferred","name":"D"},{"type":"inferred","name":"E"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"D"},"name":"D","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"E"},"name":"E","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"},{"type":"inferred","name":"D"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"D"},"name":"D","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"},"trueType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"},"falseType":{"type":"intrinsic","name":"never"}}}}}}},"permalink":"/api/args#MapParamType","previousId":173,"nextId":323},{"id":323,"name":"OptionConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Abstract type for easier typing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":210,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L210"}],"type":{"type":"intersection","types":[{"type":"reference","target":240,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Option","package":"@boost/args"},{"type":"reflection","declaration":{"id":324,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":325,"name":"arity","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":211,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L211"}],"type":{"type":"intrinsic","name":"number"}},{"id":326,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":212,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L212"}],"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}}},{"id":327,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":213,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L213"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":328,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":214,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L214"}],"type":{"type":"reference","target":167,"name":"ValueType","package":"@boost/args"}},{"id":329,"name":"multiple","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":215,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L215"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[325,326,327,328,329]}],"sources":[{"fileName":"packages/args/src/types.ts","line":210,"character":41,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L210"}]}}]},"permalink":"/api/args#OptionConfig","previousId":175,"nextId":330},{"id":330,"name":"OptionConfigMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":218,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L218"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":323,"name":"OptionConfig","package":"@boost/args"}],"name":"Record","package":"typescript"},"permalink":"/api/args#OptionConfigMap","previousId":323,"nextId":168},{"id":168,"name":"OptionMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L15"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":167,"name":"ValueType","package":"@boost/args"}],"name":"Record","package":"typescript"},"permalink":"/api/args#OptionMap","previousId":330,"nextId":331},{"id":331,"name":"ParamConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Abstract type for easier typing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":221,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L221"}],"type":{"type":"reference","target":303,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Param","package":"@boost/args"},"permalink":"/api/args#ParamConfig","previousId":168,"nextId":332},{"id":332,"name":"ParamConfigList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":223,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L223"}],"type":{"type":"array","elementType":{"type":"reference","target":331,"name":"ParamConfig","package":"@boost/args"}},"permalink":"/api/args#ParamConfigList","previousId":331,"nextId":166},{"id":166,"name":"PrimitiveType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L11"}],"type":{"type":"union","types":[{"type":"reference","target":165,"name":"ScalarType","package":"@boost/args"},{"type":"intrinsic","name":"boolean"}]},"permalink":"/api/args#PrimitiveType","previousId":332,"nextId":165},{"id":165,"name":"ScalarType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":9,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L9"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"}]},"permalink":"/api/args#ScalarType","previousId":166,"nextId":334},{"id":334,"name":"ShortOptionName","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Short option name without leading \\"-\\"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":229,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L229"}],"type":{"type":"union","types":[{"type":"literal","value":"A"},{"type":"literal","value":"a"},{"type":"literal","value":"B"},{"type":"literal","value":"b"},{"type":"literal","value":"C"},{"type":"literal","value":"c"},{"type":"literal","value":"D"},{"type":"literal","value":"d"},{"type":"literal","value":"E"},{"type":"literal","value":"e"},{"type":"literal","value":"F"},{"type":"literal","value":"f"},{"type":"literal","value":"G"},{"type":"literal","value":"g"},{"type":"literal","value":"H"},{"type":"literal","value":"h"},{"type":"literal","value":"I"},{"type":"literal","value":"i"},{"type":"literal","value":"J"},{"type":"literal","value":"j"},{"type":"literal","value":"K"},{"type":"literal","value":"k"},{"type":"literal","value":"L"},{"type":"literal","value":"l"},{"type":"literal","value":"M"},{"type":"literal","value":"m"},{"type":"literal","value":"N"},{"type":"literal","value":"n"},{"type":"literal","value":"O"},{"type":"literal","value":"o"},{"type":"literal","value":"P"},{"type":"literal","value":"p"},{"type":"literal","value":"Q"},{"type":"literal","value":"q"},{"type":"literal","value":"R"},{"type":"literal","value":"r"},{"type":"literal","value":"S"},{"type":"literal","value":"s"},{"type":"literal","value":"T"},{"type":"literal","value":"t"},{"type":"literal","value":"U"},{"type":"literal","value":"u"},{"type":"literal","value":"V"},{"type":"literal","value":"v"},{"type":"literal","value":"W"},{"type":"literal","value":"w"},{"type":"literal","value":"X"},{"type":"literal","value":"x"},{"type":"literal","value":"Y"},{"type":"literal","value":"y"},{"type":"literal","value":"Z"},{"type":"literal","value":"z"}]},"permalink":"/api/args#ShortOptionName","previousId":165,"nextId":169},{"id":169,"name":"UnknownOptionMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":17,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L17"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript"},"permalink":"/api/args#UnknownOptionMap","previousId":334,"nextId":167},{"id":167,"name":"ValueType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":13,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L13"}],"type":{"type":"union","types":[{"type":"reference","target":164,"name":"ListType","package":"@boost/args"},{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}]},"permalink":"/api/args#ValueType","previousId":169,"nextId":124},{"id":124,"name":"ArgsError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/ArgsError.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ArgsError.ts#L37"}],"type":{"type":"reflection","declaration":{"id":125,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":126,"name":"new ArgsError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":127,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"COMMAND_INVALID_FORMAT"},{"type":"literal","value":"COMMAND_NOT_FIRST"},{"type":"literal","value":"COMMAND_PROVIDED"},{"type":"literal","value":"CONTEXT_REQUIRED"},{"type":"literal","value":"GROUP_REQUIRED_COUNT"},{"type":"literal","value":"GROUP_UNSUPPORTED_TYPE"},{"type":"literal","value":"OPTION_INVALID_COUNT_TYPE"},{"type":"literal","value":"OPTION_UNKNOWN"},{"type":"literal","value":"OPTION_UNKNOWN_FORMAT"},{"type":"literal","value":"OPTION_UNKNOWN_MORE"},{"type":"literal","value":"PARAM_INVALID_ORDER"},{"type":"literal","value":"PARAM_REQUIRED"},{"type":"literal","value":"PARAM_REQUIRED_NO_DEFAULT"},{"type":"literal","value":"PARAM_UNKNOWN"},{"type":"literal","value":"SHORT_DEFINED"},{"type":"literal","value":"SHORT_INVALID_CHAR"},{"type":"literal","value":"SHORT_UNKNOWN"},{"type":"literal","value":"VALUE_INVALID_ARITY"},{"type":"literal","value":"VALUE_INVALID_CHOICE"},{"type":"literal","value":"VALUE_INVALID_FORMAT"},{"type":"literal","value":"VALUE_NO_INLINE"},{"type":"literal","value":"VALUE_NON_ARRAY"},{"type":"literal","value":"VALUE_NON_BOOL"},{"type":"literal","value":"VALUE_NON_NUMBER"},{"type":"literal","value":"VALUE_NON_STRING"}]}},{"id":128,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"COMMAND_INVALID_FORMAT"},{"type":"literal","value":"COMMAND_NOT_FIRST"},{"type":"literal","value":"COMMAND_PROVIDED"},{"type":"literal","value":"CONTEXT_REQUIRED"},{"type":"literal","value":"GROUP_REQUIRED_COUNT"},{"type":"literal","value":"GROUP_UNSUPPORTED_TYPE"},{"type":"literal","value":"OPTION_INVALID_COUNT_TYPE"},{"type":"literal","value":"OPTION_UNKNOWN"},{"type":"literal","value":"OPTION_UNKNOWN_FORMAT"},{"type":"literal","value":"OPTION_UNKNOWN_MORE"},{"type":"literal","value":"PARAM_INVALID_ORDER"},{"type":"literal","value":"PARAM_REQUIRED"},{"type":"literal","value":"PARAM_REQUIRED_NO_DEFAULT"},{"type":"literal","value":"PARAM_UNKNOWN"},{"type":"literal","value":"SHORT_DEFINED"},{"type":"literal","value":"SHORT_INVALID_CHAR"},{"type":"literal","value":"SHORT_UNKNOWN"},{"type":"literal","value":"VALUE_INVALID_ARITY"},{"type":"literal","value":"VALUE_INVALID_CHOICE"},{"type":"literal","value":"VALUE_INVALID_FORMAT"},{"type":"literal","value":"VALUE_NO_INLINE"},{"type":"literal","value":"VALUE_NON_ARRAY"},{"type":"literal","value":"VALUE_NON_BOOL"},{"type":"literal","value":"VALUE_NON_NUMBER"},{"type":"literal","value":"VALUE_NON_STRING"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/args#ArgsError","previousId":167,"nextId":132},{"id":132,"name":"COMMAND_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":8,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L8"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#COMMAND_FORMAT","previousId":124,"nextId":129},{"id":129,"name":"DEFAULT_BOOLEAN_VALUE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":2,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L2"}],"type":{"type":"literal","value":false},"defaultValue":"false","permalink":"/api/args#DEFAULT_BOOLEAN_VALUE","previousId":132,"nextId":130},{"id":130,"name":"DEFAULT_NUMBER_VALUE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L3"}],"type":{"type":"literal","value":0},"defaultValue":"0","permalink":"/api/args#DEFAULT_NUMBER_VALUE","previousId":129,"nextId":131},{"id":131,"name":"DEFAULT_STRING_VALUE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L4"}],"type":{"type":"literal","value":""},"defaultValue":"\'\'","permalink":"/api/args#DEFAULT_STRING_VALUE","previousId":130,"nextId":133},{"id":133,"name":"LONG_OPTION_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":13,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L13"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#LONG_OPTION_FORMAT","previousId":131,"nextId":136},{"id":136,"name":"OPTION_LIKE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":25,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L25"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#OPTION_LIKE","previousId":133,"nextId":134},{"id":134,"name":"SHORT_OPTION_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":17,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L17"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#SHORT_OPTION_FORMAT","previousId":136,"nextId":135},{"id":135,"name":"SHORT_OPTION_GROUP_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":21,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#SHORT_OPTION_GROUP_FORMAT","previousId":134},{"id":137,"name":"format","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/args/src/format.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/format.ts#L14"}],"signatures":[{"id":138,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format a parsed arguments object back into a command line list of arguments."}]},"sources":[{"fileName":"packages/args/src/format.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/format.ts#L14"}],"parameters":[{"id":139,"name":"argument","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":191,"typeArguments":[{"type":"reference","target":168,"name":"OptionMap","package":"@boost/args"},{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}],"name":"Arguments","package":"@boost/args"}],"name":"Partial","package":"typescript"}}],"type":{"type":"reference","target":162,"name":"Argv","package":"@boost/args"}}],"permalink":"/api/args/function/format","previousId":335,"nextId":140},{"id":140,"name":"parse","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/args/src/parse.ts","line":59,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/parse.ts#L59"}],"signatures":[{"id":141,"name":"parse","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse a list of command line arguments (typically from "},{"kind":"code","text":"`process.argv`"},{"kind":"text","text":") into an arguments\\nobject. Will extract commands, options, flags, and params based on the defined parser options."}]},"sources":[{"fileName":"packages/args/src/parse.ts","line":59,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/parse.ts#L59"}],"typeParameter":[{"id":142,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":143,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}},{"id":144,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":145,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":162,"name":"Argv","package":"@boost/args"}},{"id":146,"name":"parserOptions","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":204,"typeArguments":[{"type":"reference","target":142,"name":"O","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":144,"name":"P","package":"@boost/args","refersToTypeParameter":true}],"name":"ParserOptions","package":"@boost/args"}}],"type":{"type":"reference","target":191,"typeArguments":[{"type":"reference","target":142,"name":"O","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":144,"name":"P","package":"@boost/args","refersToTypeParameter":true}],"name":"Arguments","package":"@boost/args"}}],"permalink":"/api/args/function/parse","previousId":137,"nextId":155},{"id":155,"name":"parseInContext","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/args/src/parseInContext.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/parseInContext.ts#L17"}],"signatures":[{"id":156,"name":"parseInContext","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse a list of command line arguments (typically from "},{"kind":"code","text":"`process.argv`"},{"kind":"text","text":") into an arguments\\nobject using a context factory. The factory can customize the parser options based on the\\narguments being parsed."}]},"sources":[{"fileName":"packages/args/src/parseInContext.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/parseInContext.ts#L17"}],"typeParameter":[{"id":157,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":158,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}},{"id":159,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":160,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":162,"name":"Argv","package":"@boost/args"}},{"id":161,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":185,"name":"ContextFactory","package":"@boost/args"}}],"type":{"type":"reference","target":191,"typeArguments":[{"type":"reference","target":157,"name":"O","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":159,"name":"P","package":"@boost/args","refersToTypeParameter":true}],"name":"Arguments","package":"@boost/args"}}],"permalink":"/api/args/function/parseInContext","previousId":140,"nextId":225}],"groups":[{"title":"Classes","children":[147,335]},{"title":"Functions","children":[137,140,155]},{"title":"Interfaces","children":[225,191,320,217,213,295,276,240,303,204,200,257]},{"title":"Type Aliases","children":[170,163,123,162,181,185,223,177,171,164,333,179,173,175,323,330,168,331,332,166,165,334,169,167]},{"title":"Variables","children":[124,132,129,130,131,133,136,134,135]}],"sources":[{"fileName":"packages/args/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/index.ts#L1"}],"permalink":"/api/args"},"urlSlug":"args"}],"packageName":"@boost/args","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":9,"name":"@boost/cli","variant":"declaration","kind":2,"flags":{},"children":[{"id":1792,"name":"Arg","variant":"declaration","kind":4,"flags":{},"children":[{"id":1793,"name":"Flag","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Flag.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Flag.ts#L8"}],"signatures":[{"id":1794,"name":"Flag","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line flag (boolean value)."}]},"sources":[{"fileName":"packages/cli/src/decorators/Flag.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Flag.ts#L8"}],"parameters":[{"id":1795,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1796,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2148,"name":"Flag","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Flag"},{"id":1797,"name":"Number","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Number.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Number.ts#L8"}],"signatures":[{"id":1798,"name":"Number","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line option with a numeric value."}]},"sources":[{"fileName":"packages/cli/src/decorators/Number.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Number.ts#L8"}],"parameters":[{"id":1799,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1800,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2231,"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"SingleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Number"},{"id":1801,"name":"Numbers","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Numbers.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Numbers.ts#L8"}],"signatures":[{"id":1802,"name":"Numbers","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line option with multiple numeric values."}]},"sources":[{"fileName":"packages/cli/src/decorators/Numbers.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Numbers.ts#L8"}],"parameters":[{"id":1803,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1804,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2157,"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}}],"name":"MultipleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Numbers"},{"id":1805,"name":"Params","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Params.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Params.ts#L7"}],"signatures":[{"id":1806,"name":"Params","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator for declaring command line parameters (positional arguments)."}]},"sources":[{"fileName":"packages/cli/src/decorators/Params.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Params.ts#L7"}],"typeParameter":[{"id":1807,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"parameters":[{"id":1808,"name":"config","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":1807,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Params"},{"id":1809,"name":"String","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/String.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/String.ts#L8"}],"signatures":[{"id":1810,"name":"String","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line option with a string value."}]},"sources":[{"fileName":"packages/cli/src/decorators/String.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/String.ts#L8"}],"parameters":[{"id":1811,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1812,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2231,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SingleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#String"},{"id":1813,"name":"Strings","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Strings.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Strings.ts#L8"}],"signatures":[{"id":1814,"name":"Strings","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line option with multiple string values."}]},"sources":[{"fileName":"packages/cli/src/decorators/Strings.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Strings.ts#L8"}],"parameters":[{"id":1815,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1816,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2157,"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"MultipleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Strings"},{"id":1817,"name":"flag","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/flag.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/flag.ts#L8"}],"signatures":[{"id":1818,"name":"flag","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line flag (boolean value)."}]},"sources":[{"fileName":"packages/cli/src/initializers/flag.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/flag.ts#L8"}],"parameters":[{"id":1819,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1820,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2148,"name":"Flag","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/cli/namespace/Arg#flag"},{"id":1821,"name":"number","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/number.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/number.ts#L8"}],"signatures":[{"id":1822,"name":"number","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line option with a numeric value."}]},"sources":[{"fileName":"packages/cli/src/initializers/number.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/number.ts#L8"}],"typeParameter":[{"id":1823,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"number"},"default":{"type":"intrinsic","name":"number"}}],"parameters":[{"id":1824,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1825,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2231,"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"SingleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":1823,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"permalink":"/api/cli/namespace/Arg#number"},{"id":1826,"name":"numbers","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/numbers.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/numbers.ts#L8"}],"signatures":[{"id":1827,"name":"numbers","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line option with multiple numeric values."}]},"sources":[{"fileName":"packages/cli/src/initializers/numbers.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/numbers.ts#L8"}],"typeParameter":[{"id":1828,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"number"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"number"}}}],"parameters":[{"id":1829,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1830,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2157,"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}}],"name":"MultipleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":1828,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"permalink":"/api/cli/namespace/Arg#numbers"},{"id":1831,"name":"params","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/params.ts","line":6,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/params.ts#L6"}],"signatures":[{"id":1832,"name":"params","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring command line parameters (positional arguments)."}]},"sources":[{"fileName":"packages/cli/src/initializers/params.ts","line":6,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/params.ts#L6"}],"typeParameter":[{"id":1833,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"parameters":[{"id":1834,"name":"config","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":1833,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":1833,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}}],"permalink":"/api/cli/namespace/Arg#params"},{"id":1835,"name":"string","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/string.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/string.ts#L8"}],"signatures":[{"id":1836,"name":"string","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line option with a string value."}]},"sources":[{"fileName":"packages/cli/src/initializers/string.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/string.ts#L8"}],"typeParameter":[{"id":1837,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":1838,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1839,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2231,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SingleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":1837,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"permalink":"/api/cli/namespace/Arg#string"},{"id":1840,"name":"strings","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/strings.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/strings.ts#L8"}],"signatures":[{"id":1841,"name":"strings","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line option with multiple string values."}]},"sources":[{"fileName":"packages/cli/src/initializers/strings.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/strings.ts#L8"}],"typeParameter":[{"id":1842,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"parameters":[{"id":1843,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1844,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2157,"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"MultipleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":1842,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"permalink":"/api/cli/namespace/Arg#strings"}],"groups":[{"title":"Functions","children":[1793,1797,1801,1805,1809,1813,1817,1821,1826,1831,1835,1840]}],"sources":[{"fileName":"packages/cli/src/metadata/args.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/metadata/args.ts#L1"}],"permalink":"/api/cli/namespace/Arg","previousId":2231,"nextId":2134},{"id":1851,"name":"Command","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1864,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L117"}],"signatures":[{"id":1865,"name":"new Command","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L117"}],"typeParameter":[{"id":1866,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"},"default":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}},{"id":1867,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}},{"id":1868,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1869,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":1870,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1851,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true},{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true},{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Command","package":"@boost/cli"},"overwrites":{"type":"reference","target":-1,"name":"CommandManager.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"CommandManager.constructor"}},{"id":1876,"name":"exit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Method to exit the current program, with an optional error code."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":101,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L101"}],"type":{"type":"reference","target":2266,"name":"ExitHandler","package":"@boost/cli"}},{"id":1871,"name":"help","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Value of "},{"kind":"code","text":"`--help`"},{"kind":"text","text":", "},{"kind":"code","text":"`-h`"},{"kind":"text","text":" passed on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L84"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1872,"name":"locale","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Value of "},{"kind":"code","text":"`--locale`"},{"kind":"text","text":" passed on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":87,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L87"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'en\'"},{"id":1877,"name":"log","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Method to log to the console using a log level."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":104,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L104"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/log/src/types.ts","qualifiedName":"LoggerFunction"},"name":"LoggerFunction","package":"@boost/log"}},{"id":1925,"name":"onAfterRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a command has been registered."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.onAfterRegister"}},{"id":1926,"name":"onBeforeRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a command has been registered."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":18,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.onBeforeRegister"}},{"id":1943,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.options"}},{"id":1873,"name":"rest","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Additional arguments passed after "},{"kind":"code","text":"`--`"},{"kind":"text","text":" on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L90"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"defaultValue":"[]"},{"id":1874,"name":"unknown","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unknown options passed on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":93,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L93"}],"type":{"type":"reference","target":2250,"name":"UnknownOptionMap","package":"@boost/args"},"defaultValue":"{}"},{"id":1875,"name":"version","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Value of "},{"kind":"code","text":"`--version`"},{"kind":"text","text":", "},{"kind":"code","text":"`-v`"},{"kind":"text","text":" passed on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":96,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L96"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1852,"name":"aliases","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":57,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L57"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"defaultValue":"[]"},{"id":1853,"name":"allowUnknownOptions","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":59,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L59"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1854,"name":"allowVariadicParams","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":61,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L61"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]},"defaultValue":"false"},{"id":1855,"name":"categories","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":63,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L63"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"},"defaultValue":"{}"},{"id":1856,"name":"category","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":65,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L65"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":1858,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":69,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L69"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1857,"name":"description","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":67,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L67"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":1859,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":71,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L71"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1860,"name":"options","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":73,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L73"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"},"defaultValue":"globalOptions"},{"id":1861,"name":"params","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":75,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L75"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"},"defaultValue":"[]"},{"id":1862,"name":"path","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":77,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L77"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":1863,"name":"usage","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":79,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L79"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"defaultValue":"\'\'"},{"id":1878,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L127"}],"signatures":[{"id":1879,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Validate options passed to the constructor."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L127"}],"parameters":[{"id":1880,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"overwrites":{"type":"reference","target":-1,"name":"CommandManager.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"CommandManager.blueprint"}},{"id":1944,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1945,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1946,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1947,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1948,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1949,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.configure"}},{"id":1881,"name":"createHelp","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":134,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L134"}],"signatures":[{"id":1882,"name":"createHelp","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create a React element based on the Help component."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":134,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L134"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}],"name":"Promise","package":"typescript"},"implementationOf":{"type":"reference","target":2345,"name":"Commandable.createHelp"}}],"implementationOf":{"type":"reference","target":2345,"name":"Commandable.createHelp"}},{"id":1883,"name":"executeCommand","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":154,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L154"}],"signatures":[{"id":1884,"name":"executeCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute a system native command with the given arguments\\nand pass the results through a promise. This does *not* execute Boost CLI\\ncommands, use "},{"kind":"code","text":"`runProgram()`"},{"kind":"text","text":" instead."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":154,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L154"}],"parameters":[{"id":1885,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1886,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":1887,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"Options"},"name":"Options","package":"execa"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"ExecaReturnValue"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"ExecaReturnValue","package":"execa"}],"name":"Promise","package":"typescript"}}]},{"id":1888,"name":"getArguments","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L167"}],"signatures":[{"id":1889,"name":"getArguments","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the current command class as an arguments object.\\nOptions and params must be parsed first to operate correctly."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L167"}],"type":{"type":"reference","target":2135,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true},{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true}],"name":"Arguments","package":"@boost/args"}}]},{"id":1929,"name":"getCommand","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L27"}],"signatures":[{"id":1930,"name":"getCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a command by registered path, or "},{"kind":"code","text":"`null`"},{"kind":"text","text":" if not found."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L27"}],"typeParameter":[{"id":1931,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1932,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}},{"id":1933,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":1934,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":2344,"typeArguments":[{"type":"reference","target":1931,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":1933,"name":"P","package":"@boost/cli","refersToTypeParameter":true}],"name":"Commandable","package":"@boost/cli"}]},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommand"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommand"}},{"id":1935,"name":"getCommandPaths","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L42"}],"signatures":[{"id":1936,"name":"getCommandPaths","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all registered command paths (including aliases)."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L42"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommandPaths"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommandPaths"}},{"id":1890,"name":"getMetadata","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":181,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L181"}],"signatures":[{"id":1891,"name":"getMetadata","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Validate and return all metadata registered to this command instance."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":181,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L181"}],"type":{"type":"reference","target":2328,"name":"CommandMetadata","package":"@boost/cli"},"implementationOf":{"type":"reference","target":2348,"name":"Commandable.getMetadata"}}],"implementationOf":{"type":"reference","target":2348,"name":"Commandable.getMetadata"}},{"id":1892,"name":"getParserOptions","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":218,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L218"}],"signatures":[{"id":1893,"name":"getParserOptions","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return metadata as options for argument parsing."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":218,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L218"}],"type":{"type":"reference","target":2220,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true},{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true}],"name":"ParserOptions","package":"@boost/args"},"implementationOf":{"type":"reference","target":2351,"name":"Commandable.getParserOptions"}}],"implementationOf":{"type":"reference","target":2351,"name":"Commandable.getParserOptions"}},{"id":1894,"name":"getPath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":234,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L234"}],"signatures":[{"id":1895,"name":"getPath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the command path (canonical name on the command line)."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":234,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L234"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2354,"name":"Commandable.getPath"}}],"implementationOf":{"type":"reference","target":2354,"name":"Commandable.getPath"}},{"id":1937,"name":"register","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L50"}],"signatures":[{"id":1938,"name":"register","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a command and its canonical path (must be unique),\\notherwise an error is thrown."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L50"}],"parameters":[{"id":1939,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.register"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.register"}},{"id":1896,"name":"render","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":241,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L241"}],"signatures":[{"id":1897,"name":"render","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Render a React element with Ink and output to the configured streams."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":241,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L241"}],"parameters":[{"id":1898,"name":"element","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"},"implementationOf":{"type":"reference","target":2357,"name":"Commandable.render"}}],"implementationOf":{"type":"reference","target":2357,"name":"Commandable.render"}},{"id":1919,"name":"run","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":336,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L336"}],"signatures":[{"id":1920,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Executed when the command is being ran."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":336,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L336"}],"parameters":[{"id":1921,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true}}],"type":{"type":"union","types":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"}],"name":"Promise","package":"typescript"}]},"implementationOf":{"type":"reference","target":2361,"name":"Commandable.run"}}],"implementationOf":{"type":"reference","target":2361,"name":"Commandable.run"}},{"id":1899,"name":"runProgram","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":248,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L248"}],"signatures":[{"id":1900,"name":"runProgram","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the program within itself, by passing a custom command and argv list."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":248,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L248"}],"parameters":[{"id":1901,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","package":"typescript"}}]},{"id":1902,"name":"runTask","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":254,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L254"}],"signatures":[{"id":1903,"name":"runTask","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run a task (function) with the defined arguments and\\nthe current command instance bound to the task\'s context."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":254,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L254"}],"typeParameter":[{"id":1904,"name":"A","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":1905,"name":"R","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1906,"name":"task","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":1907,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":255,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L255"}],"signatures":[{"id":1908,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":255,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L255"}],"parameters":[{"id":1909,"name":"this","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2367,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true}],"name":"TaskContext","package":"@boost/cli"}},{"id":1910,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":1904,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":1905,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}}},{"id":1911,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":1904,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":1905,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}],"groups":[{"title":"Constructors","children":[1864]},{"title":"Properties","children":[1876,1871,1872,1877,1925,1926,1943,1873,1874,1875,1852,1853,1854,1855,1856,1858,1857,1859,1860,1861,1862,1863]},{"title":"Methods","children":[1878,1944,1881,1883,1888,1929,1935,1890,1892,1894,1937,1896,1919,1899,1902]}],"categories":[{"title":"Events","children":[1925,1926]},{"title":"__CATEGORY__","children":[1864,1876,1871,1872,1877,1943,1873,1874,1875,1852,1853,1854,1855,1856,1858,1857,1859,1860,1861,1862,1863,1878,1944,1881,1883,1888,1929,1935,1890,1892,1894,1937,1896,1919,1899,1902]}],"sources":[{"fileName":"packages/cli/src/Command.ts","line":49,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L49"}],"typeParameters":[{"id":1950,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"},"default":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}},{"id":1951,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}},{"id":1952,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1953,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":52,"character":27,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L52"}]}}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/CommandManager.ts","qualifiedName":"CommandManager"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"CommandManager","package":"@boost/cli"}],"implementedTypes":[{"type":"reference","target":2344,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true},{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true}],"name":"Commandable","package":"@boost/cli"}],"permalink":"/api/cli/class/Command","nextId":2033},{"id":2033,"name":"Program","variant":"declaration","kind":128,"flags":{},"children":[{"id":2034,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":129,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L129"}],"signatures":[{"id":2035,"name":"new Program","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":129,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L129"}],"parameters":[{"id":2036,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}},{"id":2037,"name":"streams","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2279,"name":"ProgramStreams","package":"@boost/cli"}}],"type":{"type":"reference","target":2033,"name":"Program","package":"@boost/cli"},"overwrites":{"type":"reference","target":-1,"name":"CommandManager.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"CommandManager.constructor"}},{"id":2109,"name":"onAfterRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a command has been registered."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.onAfterRegister"}},{"id":2038,"name":"onAfterRender","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a component has rendered."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":58,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L58"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2039,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the program and command have been ran."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":64,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L64"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"optional","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2110,"name":"onBeforeRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a command has been registered."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":18,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.onBeforeRegister"}},{"id":2040,"name":"onBeforeRender","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a command has run but before a component will render."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":70,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L70"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2041,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the program and command will run."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":76,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L76"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2042,"name":"onCommandFound","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when a command has been found after parsing argv."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":82,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L82"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"},{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2043,"name":"onCommandNotFound","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when a command wasn\'t found after parsing argv."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":88,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L88"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"},{"type":"intrinsic","name":"string"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2044,"name":"onExit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when the exit() handler is executed but before the process exits."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":94,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L94"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2045,"name":"onHelp","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when the help menu is rendered."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":100,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L100"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"optional","elementType":{"type":"intrinsic","name":"string"}}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2127,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.options"}},{"id":2046,"name":"streams","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/cli/src/Program.ts","line":102,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L102"}],"type":{"type":"reference","target":2279,"name":"ProgramStreams","package":"@boost/cli"},"defaultValue":"..."},{"id":2055,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":159,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L159"}],"signatures":[{"id":2056,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":159,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L159"}],"parameters":[{"id":2057,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":-1,"name":"CommandManager.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"CommandManager.blueprint"}},{"id":2058,"name":"categories","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":177,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L177"}],"signatures":[{"id":2059,"name":"categories","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define option and command categories to supply to the running command,\\nor the program itself."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":177,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L177"}],"parameters":[{"id":2060,"name":"categories","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2128,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":2129,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":2130,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":2131,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":2132,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":2133,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.configure"}},{"id":2061,"name":"default","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":187,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L187"}],"signatures":[{"id":2062,"name":"default","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a command and its canonical path as the default command.\\nA default command should be used when stand-alone binary is required."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":187,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L187"}],"parameters":[{"id":2063,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2064,"name":"exit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":202,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L202"}],"signatures":[{"id":2065,"name":"exit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Exit the program with an error code.\\nShould be called within a command or component."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":202,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L202"}],"parameters":[{"id":2066,"name":"error","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]}},{"id":2067,"name":"errorCode","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"never"}}]},{"id":2113,"name":"getCommand","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L27"}],"signatures":[{"id":2114,"name":"getCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a command by registered path, or "},{"kind":"code","text":"`null`"},{"kind":"text","text":" if not found."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L27"}],"typeParameter":[{"id":2115,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":2116,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}},{"id":2117,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":2118,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":2344,"typeArguments":[{"type":"reference","target":1931,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":1933,"name":"P","package":"@boost/cli","refersToTypeParameter":true}],"name":"Commandable","package":"@boost/cli"}]},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommand"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommand"}},{"id":2119,"name":"getCommandPaths","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L42"}],"signatures":[{"id":2120,"name":"getCommandPaths","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all registered command paths (including aliases)."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L42"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommandPaths"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommandPaths"}},{"id":2068,"name":"middleware","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":226,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L226"}],"signatures":[{"id":2069,"name":"middleware","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define a middleware function to apply to the argv list or args object."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":226,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L226"}],"parameters":[{"id":2070,"name":"middleware","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2394,"name":"Middleware","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2071,"name":"parse","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":239,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L239"}],"signatures":[{"id":2072,"name":"parse","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse the arguments list according to the number of commands that have been registered."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":239,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L239"}],"typeParameter":[{"id":2073,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}},{"id":2074,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":2075,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}}],"type":{"type":"reference","target":2135,"typeArguments":[{"type":"reference","target":2073,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":2074,"name":"P","package":"@boost/cli","refersToTypeParameter":true}],"name":"Arguments","package":"@boost/args"}}]},{"id":2121,"name":"register","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L50"}],"signatures":[{"id":2122,"name":"register","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a command and its canonical path (must be unique),\\notherwise an error is thrown."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L50"}],"parameters":[{"id":2123,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.register"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.register"}},{"id":2076,"name":"renderElement","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":271,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L271"}],"signatures":[{"id":2077,"name":"renderElement","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Render a React element with Ink and output to the configured streams."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":271,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L271"}],"parameters":[{"id":2078,"name":"element","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]},{"id":2079,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":336,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L336"}],"signatures":[{"id":2080,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the program in the following steps:\\n- Apply middleware to argv list.\\n- Parse argv into an args object (of options, params, etc).\\n- Determine command to run, or fail.\\n- Run command and render output.\\n- Return exit code."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":336,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L336"}],"parameters":[{"id":2081,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}},{"id":2082,"name":"bootstrap","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2287,"name":"ProgramBootstrap","package":"@boost/cli"}},{"id":2083,"name":"rethrow","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","package":"typescript"}}]},{"id":2084,"name":"runAndExit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":368,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L368"}],"signatures":[{"id":2085,"name":"runAndExit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the program and also set the process exit code."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":368,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L368"}],"parameters":[{"id":2086,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}},{"id":2087,"name":"bootstrap","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2287,"name":"ProgramBootstrap","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[2034]},{"title":"Properties","children":[2109,2038,2039,2110,2040,2041,2042,2043,2044,2045,2127,2046]},{"title":"Methods","children":[2055,2058,2128,2061,2064,2113,2119,2068,2071,2121,2076,2079,2084]}],"categories":[{"title":"Events","children":[2109,2038,2039,2110,2040,2041,2042,2043,2044,2045]},{"title":"__CATEGORY__","children":[2034,2127,2046,2055,2058,2128,2061,2064,2113,2119,2068,2071,2121,2076,2079,2084]}],"sources":[{"fileName":"packages/cli/src/Program.ts","line":53,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L53"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/CommandManager.ts","qualifiedName":"CommandManager"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"CommandManager","package":"@boost/cli"}],"permalink":"/api/cli/class/Program","previousId":1851,"nextId":1787},{"id":2135,"name":"Arguments","variant":"declaration","kind":256,"flags":{},"children":[{"id":2136,"name":"command","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current running command and sub-commads. Is an array split on \\":\\"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":41,"character":4}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2137,"name":"errors","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of errors detected during argument parsing."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":43,"character":4}],"type":{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}},{"id":2138,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of options to their values passed on the command line (or their default)."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":45,"character":4}],"type":{"type":"reference","target":2142,"name":"O","package":"@boost/args","qualifiedName":"Arguments.O","refersToTypeParameter":true}},{"id":2139,"name":"params","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of parameter values passed on the command line."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":47,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamType"},"typeArguments":[{"type":"reference","target":2143,"name":"P","package":"@boost/args","qualifiedName":"Arguments.P","refersToTypeParameter":true}],"name":"MapParamType","package":"@boost/args"}},{"id":2140,"name":"rest","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of arguments that appear after \\"--\\" on the command line."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":49,"character":4}],"type":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}},{"id":2141,"name":"unknown","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of unconfigured options to string values."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":51,"character":4}],"type":{"type":"reference","target":2250,"name":"UnknownOptionMap","package":"@boost/args"}}],"groups":[{"title":"Properties","children":[2136,2137,2138,2139,2140,2141]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":39,"character":17}],"typeParameters":[{"id":2142,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":2143,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"permalink":"/api/cli/interface/Arguments","previousId":2022,"nextId":2145},{"id":2145,"name":"Category","variant":"declaration","kind":256,"flags":{},"children":[{"id":2146,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":133,"character":4}],"type":{"type":"intrinsic","name":"string"}},{"id":2147,"name":"weight","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":134,"character":4}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[2146,2147]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":132,"character":17}],"permalink":"/api/cli/interface/Category","previousId":2135,"nextId":2292},{"id":2292,"name":"CommandConfig","variant":"declaration","kind":256,"flags":{},"children":[{"id":2293,"name":"aliases","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A list of aliased paths. Will not show up in the help menu, but will match on the command line."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":115,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L115"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2294,"name":"allowUnknownOptions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L117"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2295,"name":"allowVariadicParams","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L119"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]}},{"id":2296,"name":"categories","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A mapping of sub-command and option categories for this command only. Global options are automatically defined under the "},{"kind":"code","text":"`global`"},{"kind":"text","text":" category."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L121"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"}},{"id":2300,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":79,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.category"}},{"id":2302,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.deprecated"}},{"id":2303,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.description"}},{"id":2304,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.hidden"}},{"id":2297,"name":"options","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A mapping of options to their configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L123"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"}},{"id":2298,"name":"params","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A list of param (positional args) configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L125"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"}},{"id":2299,"name":"path","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique name in which to match the command on the command line amongst a list of arguments (argv)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L127"}],"type":{"type":"intrinsic","name":"string"}},{"id":2301,"name":"usage","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Define one or many usage examples to display in the help menu."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":81,"character":4}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.usage"}}],"groups":[{"title":"Properties","children":[2293,2294,2295,2296,2300,2302,2303,2304,2297,2298,2299,2301]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":113,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L113"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"Command"},"name":"Command","package":"@boost/args"}],"permalink":"/api/cli/interface/CommandConfig","previousId":2145,"nextId":2328},{"id":2328,"name":"CommandMetadata","variant":"declaration","kind":256,"flags":{},"children":[{"id":2331,"name":"aliases","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A list of aliased paths. Will not show up in the help menu, but will match on the command line."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":115,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L115"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"inheritedFrom":{"type":"reference","target":2316,"name":"CommandStaticConfig.aliases"}},{"id":2332,"name":"allowUnknownOptions","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L117"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2317,"name":"CommandStaticConfig.allowUnknownOptions"}},{"id":2333,"name":"allowVariadicParams","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L119"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]},"inheritedFrom":{"type":"reference","target":2318,"name":"CommandStaticConfig.allowVariadicParams"}},{"id":2334,"name":"categories","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A mapping of sub-command and option categories for this command only. Global options are automatically defined under the "},{"kind":"code","text":"`global`"},{"kind":"text","text":" category."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L121"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":2319,"name":"CommandStaticConfig.categories"}},{"id":2338,"name":"category","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":79,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2323,"name":"CommandStaticConfig.category"}},{"id":2329,"name":"commands","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":144,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L144"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}],"name":"Record","package":"typescript"}},{"id":2340,"name":"deprecated","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2325,"name":"CommandStaticConfig.deprecated"}},{"id":2341,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2326,"name":"CommandStaticConfig.description"}},{"id":2330,"name":"hasRegisteredOptions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/types.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L140"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2315,"name":"CommandStaticConfig.hasRegisteredOptions"}},{"id":2342,"name":"hidden","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2327,"name":"CommandStaticConfig.hidden"}},{"id":2335,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A mapping of options to their configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L123"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2320,"name":"CommandStaticConfig.options"}},{"id":2336,"name":"params","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A list of param (positional args) configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L125"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2321,"name":"CommandStaticConfig.params"}},{"id":2337,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A unique name in which to match the command on the command line amongst a list of arguments (argv)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L127"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2322,"name":"CommandStaticConfig.path"}},{"id":2339,"name":"usage","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define one or many usage examples to display in the help menu."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":81,"character":4}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"inheritedFrom":{"type":"reference","target":2324,"name":"CommandStaticConfig.usage"}}],"groups":[{"title":"Properties","children":[2331,2332,2333,2334,2338,2329,2340,2341,2330,2342,2335,2336,2337,2339]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":143,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L143"}],"extendedTypes":[{"type":"reference","target":2314,"name":"CommandStaticConfig","package":"@boost/cli"}],"permalink":"/api/cli/interface/CommandMetadata","previousId":2292,"nextId":2314},{"id":2314,"name":"CommandStaticConfig","variant":"declaration","kind":256,"flags":{},"children":[{"id":2316,"name":"aliases","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A list of aliased paths. Will not show up in the help menu, but will match on the command line."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":115,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L115"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.aliases"}},{"id":2317,"name":"allowUnknownOptions","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L117"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.allowUnknownOptions"}},{"id":2318,"name":"allowVariadicParams","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L119"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.allowVariadicParams"}},{"id":2319,"name":"categories","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A mapping of sub-command and option categories for this command only. Global options are automatically defined under the "},{"kind":"code","text":"`global`"},{"kind":"text","text":" category."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L121"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.categories"}},{"id":2323,"name":"category","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":79,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.category"}},{"id":2325,"name":"deprecated","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.deprecated"}},{"id":2326,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.description"}},{"id":2315,"name":"hasRegisteredOptions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/types.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L140"}],"type":{"type":"intrinsic","name":"string"}},{"id":2327,"name":"hidden","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.hidden"}},{"id":2320,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A mapping of options to their configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L123"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.options"}},{"id":2321,"name":"params","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A list of param (positional args) configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L125"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.params"}},{"id":2322,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A unique name in which to match the command on the command line amongst a list of arguments (argv)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L127"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.path"}},{"id":2324,"name":"usage","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define one or many usage examples to display in the help menu."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":81,"character":4}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.usage"}}],"groups":[{"title":"Properties","children":[2316,2317,2318,2319,2323,2325,2326,2315,2327,2320,2321,2322,2324]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":139,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L139"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2292,"name":"CommandConfig","package":"@boost/cli"}],"name":"Required","package":"typescript"}],"extendedBy":[{"type":"reference","target":2328,"name":"CommandMetadata"}],"permalink":"/api/cli/interface/CommandStaticConfig","previousId":2328,"nextId":2344},{"id":2344,"name":"Commandable","variant":"declaration","kind":256,"flags":{},"children":[{"id":2345,"name":"createHelp","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":150,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L150"}],"type":{"type":"reflection","declaration":{"id":2346,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":150,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L150"}],"signatures":[{"id":2347,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":150,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L150"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}]}],"name":"Promise","package":"typescript"}}]}}},{"id":2348,"name":"getMetadata","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":151,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L151"}],"type":{"type":"reflection","declaration":{"id":2349,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":151,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L151"}],"signatures":[{"id":2350,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":151,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L151"}],"type":{"type":"reference","target":2328,"name":"CommandMetadata","package":"@boost/cli"}}]}}},{"id":2351,"name":"getParserOptions","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":152,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L152"}],"type":{"type":"reflection","declaration":{"id":2352,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":152,"character":19,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L152"}],"signatures":[{"id":2353,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":152,"character":19,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L152"}],"type":{"type":"reference","target":2220,"typeArguments":[{"type":"reference","target":2365,"name":"O","package":"@boost/cli","qualifiedName":"Commandable.O","refersToTypeParameter":true},{"type":"reference","target":2366,"name":"P","package":"@boost/cli","qualifiedName":"Commandable.P","refersToTypeParameter":true}],"name":"ParserOptions","package":"@boost/args"}}]}}},{"id":2354,"name":"getPath","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L153"}],"type":{"type":"reflection","declaration":{"id":2355,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":153,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L153"}],"signatures":[{"id":2356,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":153,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L153"}],"type":{"type":"intrinsic","name":"string"}}]}}},{"id":2357,"name":"render","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":154,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L154"}],"type":{"type":"reflection","declaration":{"id":2358,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":154,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L154"}],"signatures":[{"id":2359,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":154,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L154"}],"parameters":[{"id":2360,"name":"element","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]}}},{"id":2361,"name":"run","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":155,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L155"}],"type":{"type":"reflection","declaration":{"id":2362,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":155,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L155"}],"signatures":[{"id":2363,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":155,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L155"}],"parameters":[{"id":2364,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":2366,"name":"P","package":"@boost/cli","qualifiedName":"Commandable.P","refersToTypeParameter":true}}],"type":{"type":"union","types":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"}],"name":"Promise","package":"typescript"}]}}]}}}],"groups":[{"title":"Properties","children":[2345,2348,2351,2354,2357,2361]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":149,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L149"}],"typeParameters":[{"id":2365,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"intrinsic","name":"any"}},{"id":2366,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"implementedBy":[{"type":"reference","target":1851,"name":"Command"}],"permalink":"/api/cli/interface/Commandable","previousId":2314,"nextId":2148},{"id":2148,"name":"Flag","variant":"declaration","kind":256,"flags":{},"children":[{"id":2150,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":104,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.category"}},{"id":2149,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":123,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","target":-1,"name":"Omit.default"}},{"id":2153,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.deprecated"}},{"id":2154,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.description"}},{"id":2155,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.hidden"}},{"id":2151,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":106,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ShortOptionName"},"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.short"}},{"id":2152,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"literal","value":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.type"}}],"groups":[{"title":"Properties","children":[2150,2149,2153,2154,2155,2151,2152]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":122,"character":17}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2176,"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Option","package":"@boost/args"},{"type":"union","types":[{"type":"literal","value":"format"},{"type":"literal","value":"validate"}]}],"name":"Omit","package":"typescript"}],"permalink":"/api/cli/interface/Flag","previousId":2344,"nextId":2256},{"id":2256,"name":"GlobalOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2257,"name":"help","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":59,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L59"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2258,"name":"locale","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":60,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L60"}],"type":{"type":"intrinsic","name":"string"}},{"id":2259,"name":"version","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":61,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L61"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2257,2258,2259]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":58,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L58"}],"permalink":"/api/cli/interface/GlobalOptions","previousId":2148,"nextId":2157},{"id":2157,"name":"MultipleOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":2158,"name":"arity","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error unless the list of values satisfy this required length."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":117,"character":4}],"type":{"type":"intrinsic","name":"number"}},{"id":2161,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":104,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2177,"name":"Option.category"}},{"id":2159,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":118,"character":4}],"type":{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true},"overwrites":{"type":"reference","target":2179,"name":"Option.default"}},{"id":2172,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2189,"name":"Option.deprecated"}},{"id":2173,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2190,"name":"Option.description"}},{"id":2163,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":4}],"type":{"type":"reflection","declaration":{"id":2164,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"signatures":[{"id":2165,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"parameters":[{"id":2166,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":2180,"name":"Option.format"}},{"id":2174,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2191,"name":"Option.hidden"}},{"id":2160,"name":"multiple","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow multiple values to be passed."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":120,"character":4}],"type":{"type":"literal","value":true}},{"id":2162,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":106,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ShortOptionName"},"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2178,"name":"Option.short"}},{"id":2167,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"InferArgType"},"typeArguments":[{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2184,"name":"Option.type"}},{"id":2168,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":4}],"type":{"type":"reflection","declaration":{"id":2169,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"signatures":[{"id":2170,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"parameters":[{"id":2171,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":2185,"name":"Option.validate"}}],"groups":[{"title":"Properties","children":[2158,2161,2159,2172,2173,2163,2174,2160,2162,2167,2168]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":115,"character":17}],"typeParameters":[{"id":2175,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2156,"name":"ListType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":2176,"typeArguments":[{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}],"name":"Option","package":"@boost/args"}],"permalink":"/api/cli/interface/MultipleOption","previousId":2256,"nextId":2176},{"id":2176,"name":"Option","variant":"declaration","kind":256,"flags":{},"children":[{"id":2177,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":104,"character":4}],"type":{"type":"intrinsic","name":"string"}},{"id":2179,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":94,"character":4}],"type":{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.default"}},{"id":2189,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.deprecated"}},{"id":2190,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.description"}},{"id":2180,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":4}],"type":{"type":"reflection","declaration":{"id":2181,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"signatures":[{"id":2182,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"parameters":[{"id":2183,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.format"}},{"id":2191,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.hidden"}},{"id":2178,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":106,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ShortOptionName"},"name":"ShortOptionName","package":"@boost/args"}},{"id":2184,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"InferArgType"},"typeArguments":[{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.type"}},{"id":2185,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":4}],"type":{"type":"reflection","declaration":{"id":2186,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"signatures":[{"id":2187,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"parameters":[{"id":2188,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.validate"}}],"groups":[{"title":"Properties","children":[2177,2179,2189,2190,2180,2191,2178,2184,2185]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":102,"character":17}],"typeParameters":[{"id":2192,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2251,"name":"ValueType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"Arg"},"typeArguments":[{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}],"name":"Arg","package":"@boost/args"}],"extendedBy":[{"type":"reference","target":2157,"name":"MultipleOption"},{"type":"reference","target":2231,"name":"SingleOption"}],"permalink":"/api/cli/interface/Option","previousId":2157,"nextId":2306},{"id":2306,"name":"OptionInitializer","variant":"declaration","kind":256,"flags":{},"children":[{"id":2313,"name":"[INTERNAL_INITIALIZER]","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":133,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L133"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2307,"name":"register","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":134,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L134"}],"type":{"type":"reflection","declaration":{"id":2308,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":134,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L134"}],"signatures":[{"id":2309,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":134,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L134"}],"parameters":[{"id":2310,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}},{"id":2311,"name":"property","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2312,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":135,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L135"}],"type":{"type":"intrinsic","name":"unknown"}}],"groups":[{"title":"Properties","children":[2313,2307,2312]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":132,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L132"}],"permalink":"/api/cli/interface/OptionInitializer","previousId":2176,"nextId":2201},{"id":2201,"name":"Param","variant":"declaration","kind":256,"flags":{},"children":[{"id":2204,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":94,"character":4}],"type":{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.default"}},{"id":2214,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.deprecated"}},{"id":2215,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.description"}},{"id":2205,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":4}],"type":{"type":"reflection","declaration":{"id":2206,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"signatures":[{"id":2207,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"parameters":[{"id":2208,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.format"}},{"id":2216,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.hidden"}},{"id":2202,"name":"label","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Informational label to display in terminal output."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":127,"character":4}],"type":{"type":"intrinsic","name":"string"}},{"id":2203,"name":"required","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the param is required or not. If required and not passed, the\\nparser will throw an error. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":130,"character":4}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2209,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"InferArgType"},"typeArguments":[{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.type"}},{"id":2210,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":4}],"type":{"type":"reflection","declaration":{"id":2211,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"signatures":[{"id":2212,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"parameters":[{"id":2213,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.validate"}}],"groups":[{"title":"Properties","children":[2204,2214,2215,2205,2216,2202,2203,2209,2210]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":125,"character":17}],"typeParameters":[{"id":2217,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"Arg"},"typeArguments":[{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}],"name":"Arg","package":"@boost/args"}],"permalink":"/api/cli/interface/Param","previousId":2306,"nextId":2220},{"id":2220,"name":"ParserOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2221,"name":"commands","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of valid commands. Sub-commands should be denoted with \\":\\"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":63,"character":4}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"CommandChecker"},"name":"CommandChecker","package":"@boost/args"}]}},{"id":2224,"name":"loose","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Enable loose mode parsing."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":55,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParserSettings.loose"}},{"id":2222,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of options to their type and configurations."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":65,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapOptionConfig"},"typeArguments":[{"type":"reference","target":2227,"name":"O","package":"@boost/args","qualifiedName":"ParserOptions.O","refersToTypeParameter":true}],"name":"MapOptionConfig","package":"@boost/args"}},{"id":2223,"name":"params","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of param configurations (in order)."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":67,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":2228,"name":"P","package":"@boost/args","qualifiedName":"ParserOptions.P","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}},{"id":2225,"name":"unknown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be passed. Will be placed in a special "},{"kind":"code","text":"`unknown`"},{"kind":"text","text":" object."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":57,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParserSettings.unknown"}},{"id":2226,"name":"variadic","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be passed. Will be accumlated after configured params."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":59,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParserSettings.variadic"}}],"groups":[{"title":"Properties","children":[2221,2224,2222,2223,2225,2226]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":61,"character":17}],"typeParameters":[{"id":2227,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":2228,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ParserSettings"},"name":"ParserSettings","package":"@boost/args"}],"permalink":"/api/cli/interface/ParserOptions","previousId":2201,"nextId":2283},{"id":2283,"name":"ProgramContextType","variant":"declaration","kind":256,"flags":{},"children":[{"id":2284,"name":"exit","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":100,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L100"}],"type":{"type":"reference","target":2266,"name":"ExitHandler","package":"@boost/cli"}},{"id":2285,"name":"log","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":101,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L101"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/log/src/types.ts","qualifiedName":"LoggerFunction"},"name":"LoggerFunction","package":"@boost/log"}},{"id":2286,"name":"program","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":102,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L102"}],"type":{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}}],"groups":[{"title":"Properties","children":[2284,2285,2286]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":99,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L99"}],"permalink":"/api/cli/interface/ProgramContextType","previousId":2220,"nextId":2271},{"id":2271,"name":"ProgramOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2272,"name":"banner","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A large banner to appear at the top of the index help interface."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L78"}],"type":{"type":"intrinsic","name":"string"}},{"id":2273,"name":"bin","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The name of the binary consumers enter on the command line. Must be in kebab-case."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":80,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L80"}],"type":{"type":"intrinsic","name":"string"}},{"id":2274,"name":"delimiter","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The character(s) displayed before command line usage examples."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":82,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L82"}],"type":{"type":"intrinsic","name":"string"}},{"id":2275,"name":"footer","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A string of text to display at the bottom of the index help interface."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L84"}],"type":{"type":"intrinsic","name":"string"}},{"id":2276,"name":"header","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A string of text to display at the top of the index help interface, below the banner (if present)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":86,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L86"}],"type":{"type":"intrinsic","name":"string"}},{"id":2277,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A human readable name for your program."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":88,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L88"}],"type":{"type":"intrinsic","name":"string"}},{"id":2278,"name":"version","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current version of your CLI program. Typically the version found in your "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":". This is output when "},{"kind":"code","text":"`--version`"},{"kind":"text","text":" is passed."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L90"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2272,2273,2274,2275,2276,2277,2278]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":76,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L76"}],"extendedBy":[{"type":"reference","target":2465,"name":"IndexHelpProps"}],"permalink":"/api/cli/interface/ProgramOptions","previousId":2283,"nextId":2279},{"id":2279,"name":"ProgramStreams","variant":"declaration","kind":256,"flags":{},"children":[{"id":2280,"name":"stderr","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":94,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L94"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/process.d.ts","qualifiedName":"__global.NodeJS.WriteStream"},"name":"WriteStream","package":"@types/node","qualifiedName":"__global.NodeJS.WriteStream"}},{"id":2281,"name":"stdin","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L95"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/process.d.ts","qualifiedName":"__global.NodeJS.ReadStream"},"name":"ReadStream","package":"@types/node","qualifiedName":"__global.NodeJS.ReadStream"}},{"id":2282,"name":"stdout","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":96,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L96"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/process.d.ts","qualifiedName":"__global.NodeJS.WriteStream"},"name":"WriteStream","package":"@types/node","qualifiedName":"__global.NodeJS.WriteStream"}}],"groups":[{"title":"Properties","children":[2280,2281,2282]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":93,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L93"}],"permalink":"/api/cli/interface/ProgramStreams","previousId":2271,"nextId":2231},{"id":2231,"name":"SingleOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":2235,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":104,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2177,"name":"Option.category"}},{"id":2232,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whitelist of acceptable values."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":110,"character":4}],"type":{"type":"array","elementType":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}},{"id":2233,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"When found in an option group, increment the value for each occurrence. _(Numbers only)_"}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":112,"character":4}],"type":{"type":"conditional","checkType":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"number"},"trueType":{"type":"literal","value":true},"falseType":{"type":"intrinsic","name":"never"}}},{"id":2234,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":113,"character":4}],"type":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true},"overwrites":{"type":"reference","target":2179,"name":"Option.default"}},{"id":2246,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2189,"name":"Option.deprecated"}},{"id":2247,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2190,"name":"Option.description"}},{"id":2237,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":4}],"type":{"type":"reflection","declaration":{"id":2238,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"signatures":[{"id":2239,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"parameters":[{"id":2240,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":2180,"name":"Option.format"}},{"id":2248,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2191,"name":"Option.hidden"}},{"id":2236,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":106,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ShortOptionName"},"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2178,"name":"Option.short"}},{"id":2241,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"InferArgType"},"typeArguments":[{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2184,"name":"Option.type"}},{"id":2242,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":4}],"type":{"type":"reflection","declaration":{"id":2243,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"signatures":[{"id":2244,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"parameters":[{"id":2245,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":2185,"name":"Option.validate"}}],"groups":[{"title":"Properties","children":[2235,2232,2233,2234,2246,2247,2237,2248,2236,2241,2242]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":108,"character":17}],"typeParameters":[{"id":2249,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2230,"name":"ScalarType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":2176,"typeArguments":[{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}],"name":"Option","package":"@boost/args"}],"permalink":"/api/cli/interface/SingleOption","previousId":2279,"nextId":1792},{"id":2134,"name":"ArgList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":2,"character":12}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"permalink":"/api/cli#ArgList","previousId":1792,"nextId":2144},{"id":2144,"name":"Argv","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":1,"character":12}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"permalink":"/api/cli#Argv","previousId":2134,"nextId":1845},{"id":1845,"name":"CLIErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/CLIError.ts","line":24,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CLIError.ts#L24"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/CLIError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/cli","preferValues":true}}},"permalink":"/api/cli#CLIErrorCode","previousId":2144,"nextId":2264},{"id":2264,"name":"Categories","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":68,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L68"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"union","types":[{"type":"reference","target":2145,"name":"Category","package":"@boost/args"},{"type":"intrinsic","name":"string"}]}],"name":"Record","package":"typescript"},"permalink":"/api/cli#Categories","previousId":1845,"nextId":2011},{"id":2011,"name":"CategoryItemMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L3"}],"typeParameters":[{"id":2015,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reflection","declaration":{"id":2012,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2013,"name":"items","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":6,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L6"}],"type":{"type":"array","elementType":{"type":"reference","target":2015,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}},{"id":2014,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":7,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L7"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2013,2014]}],"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":5,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L5"}]}}],"name":"Record","package":"typescript"},"permalink":"/api/cli#CategoryItemMap","previousId":2264,"nextId":2305},{"id":2305,"name":"CommandConfigMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":130,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L130"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2292,"name":"CommandConfig","package":"@boost/cli"}],"name":"Record","package":"typescript"},"permalink":"/api/cli#CommandConfigMap","previousId":2011,"nextId":2343},{"id":2343,"name":"CommandMetadataMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":147,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L147"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2328,"name":"CommandMetadata","package":"@boost/cli"}],"name":"Record","package":"typescript"},"permalink":"/api/cli#CommandMetadataMap","previousId":2305,"nextId":2291},{"id":2291,"name":"CommandPath","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":111,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L111"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/cli#CommandPath","previousId":2343,"nextId":2265},{"id":2265,"name":"ExitCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":72,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L72"}],"type":{"type":"intrinsic","name":"number"},"permalink":"/api/cli#ExitCode","previousId":2291,"nextId":2266},{"id":2266,"name":"ExitHandler","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":74,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L74"}],"type":{"type":"reflection","declaration":{"id":2267,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":74,"character":26,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L74"}],"signatures":[{"id":2268,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2269,"name":"error","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"intrinsic","name":"string"}]}},{"id":2270,"name":"code","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"void"}}]}},"permalink":"/api/cli#ExitHandler","previousId":2265,"nextId":2156},{"id":2156,"name":"ListType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":3,"character":12}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"permalink":"/api/cli#ListType","previousId":2266,"nextId":2394},{"id":2394,"name":"Middleware","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":176,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L176"}],"type":{"type":"reflection","declaration":{"id":2395,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":176,"character":25,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L176"}],"signatures":[{"id":2396,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2397,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}},{"id":2398,"name":"parse","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2390,"name":"MiddlewareCallback","package":"@boost/cli"}},{"id":2399,"name":"logger","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/log/src/types.ts","qualifiedName":"Loggable"},"name":"Loggable","package":"@boost/log"}}],"type":{"type":"union","types":[{"type":"reference","target":2389,"name":"MiddlewareArguments","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2389,"name":"MiddlewareArguments","package":"@boost/cli"}],"name":"Promise","package":"typescript"}]}}]}},"permalink":"/api/cli#Middleware","previousId":2156,"nextId":2389},{"id":2389,"name":"MiddlewareArguments","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":172,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L172"}],"type":{"type":"reference","target":2135,"typeArguments":[{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"},{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}],"name":"Arguments","package":"@boost/args"},"permalink":"/api/cli#MiddlewareArguments","previousId":2394,"nextId":2390},{"id":2390,"name":"MiddlewareCallback","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":174,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L174"}],"type":{"type":"reflection","declaration":{"id":2391,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":174,"character":33,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L174"}],"signatures":[{"id":2392,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2393,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}}],"type":{"type":"union","types":[{"type":"reference","target":2389,"name":"MiddlewareArguments","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2389,"name":"MiddlewareArguments","package":"@boost/cli"}],"name":"Promise","package":"typescript"}]}}]}},"permalink":"/api/cli#MiddlewareCallback","previousId":2389,"nextId":2193},{"id":2193,"name":"OptionConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Abstract type for easier typing."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":137,"character":12}],"type":{"type":"intersection","types":[{"type":"reference","target":2176,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Option","package":"@boost/args"},{"type":"reflection","declaration":{"id":2194,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2195,"name":"arity","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":138,"character":4}],"type":{"type":"intrinsic","name":"number"}},{"id":2196,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":139,"character":4}],"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}},{"id":2197,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":140,"character":4}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2198,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":141,"character":4}],"type":{"type":"reference","target":2251,"name":"ValueType","package":"@boost/args"}},{"id":2199,"name":"multiple","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":142,"character":4}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2195,2196,2197,2198,2199]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":137,"character":41}]}}]},"permalink":"/api/cli#OptionConfig","previousId":2390,"nextId":2200},{"id":2200,"name":"OptionConfigMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":144,"character":12}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2193,"name":"OptionConfig","package":"@boost/args"}],"name":"Record","package":"typescript"},"permalink":"/api/cli#OptionConfigMap","previousId":2193,"nextId":2260},{"id":2260,"name":"Options","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":64,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L64"}],"typeParameters":[{"id":2261,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapOptionConfig"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2261,"name":"T","package":"@boost/cli","refersToTypeParameter":true},{"type":"typeOperator","operator":"keyof","target":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}}],"name":"Omit","package":"typescript"}],"name":"MapOptionConfig","package":"@boost/args"},"permalink":"/api/cli#Options","previousId":2200,"nextId":2218},{"id":2218,"name":"ParamConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Abstract type for easier typing."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":146,"character":12}],"type":{"type":"reference","target":2201,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Param","package":"@boost/args"},"permalink":"/api/cli#ParamConfig","previousId":2260,"nextId":2219},{"id":2219,"name":"ParamConfigList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":147,"character":12}],"type":{"type":"array","elementType":{"type":"reference","target":2218,"name":"ParamConfig","package":"@boost/args"}},"permalink":"/api/cli#ParamConfigList","previousId":2218,"nextId":2262},{"id":2262,"name":"Params","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":66,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L66"}],"typeParameters":[{"id":2263,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":2263,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"},"permalink":"/api/cli#Params","previousId":2219,"nextId":2252},{"id":2252,"name":"PartialConfig","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":54,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L54"}],"typeParameters":[{"id":2253,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2253,"name":"T","package":"@boost/cli","refersToTypeParameter":true},{"type":"union","types":[{"type":"literal","value":"description"},{"type":"literal","value":"multiple"},{"type":"literal","value":"path"},{"type":"literal","value":"type"}]}],"name":"Omit","package":"typescript"},"permalink":"/api/cli#PartialConfig","previousId":2262,"nextId":2229},{"id":2229,"name":"PrimitiveType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":5,"character":12}],"type":{"type":"union","types":[{"type":"reference","target":2230,"name":"ScalarType","package":"@boost/args"},{"type":"intrinsic","name":"boolean"}]},"permalink":"/api/cli#PrimitiveType","previousId":2252,"nextId":2287},{"id":2287,"name":"ProgramBootstrap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":105,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L105"}],"type":{"type":"reflection","declaration":{"id":2288,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":105,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L105"}],"signatures":[{"id":2289,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"},{"type":"intrinsic","name":"void"}]}}]}},"permalink":"/api/cli#ProgramBootstrap","previousId":2229,"nextId":2290},{"id":2290,"name":"RunResult","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":109,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L109"}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"void"}]},"permalink":"/api/cli#RunResult","previousId":2287,"nextId":2230},{"id":2230,"name":"ScalarType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":4,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"}]},"permalink":"/api/cli#ScalarType","previousId":2290,"nextId":2400},{"id":2400,"name":"StyleType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":184,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L184"}],"type":{"type":"union","types":[{"type":"literal","value":"default"},{"type":"literal","value":"failure"},{"type":"literal","value":"info"},{"type":"literal","value":"inverted"},{"type":"literal","value":"muted"},{"type":"literal","value":"notice"},{"type":"literal","value":"success"},{"type":"literal","value":"warning"}]},"permalink":"/api/cli#StyleType","previousId":2230,"nextId":2367},{"id":2367,"name":"TaskContext","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":160,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L160"}],"typeParameters":[{"id":2388,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"},"default":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}}],"type":{"type":"intersection","types":[{"type":"reference","target":2388,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reflection","declaration":{"id":2368,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2369,"name":"exit","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":161,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L161"}],"type":{"type":"reference","target":2266,"name":"ExitHandler","package":"@boost/cli"}},{"id":2370,"name":"log","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L162"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/log/src/types.ts","qualifiedName":"LoggerFunction"},"name":"LoggerFunction","package":"@boost/log"}},{"id":2371,"name":"rest","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":163,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L163"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2373,"name":"runProgram","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":2374,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":166,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L166"}],"signatures":[{"id":2375,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2376,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"}],"name":"Promise","package":"typescript"}}]}}},{"id":2377,"name":"runTask","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L167"}],"type":{"type":"reflection","declaration":{"id":2378,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":167,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L167"}],"signatures":[{"id":2379,"name":"__type","variant":"signature","kind":4096,"flags":{},"typeParameter":[{"id":2386,"name":"A","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":2387,"name":"R","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2380,"name":"task","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":2381,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":167,"character":41,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L167"}],"signatures":[{"id":2382,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2383,"name":"this","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2367,"typeArguments":[{"type":"reference","target":2388,"name":"O","package":"@boost/cli","refersToTypeParameter":true}],"name":"TaskContext","package":"@boost/cli"}},{"id":2384,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":2386,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":2387,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}}},{"id":2385,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":2386,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":2387,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}}},{"id":2372,"name":"unknown","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L164"}],"type":{"type":"reference","target":2250,"name":"UnknownOptionMap","package":"@boost/args"}}],"groups":[{"title":"Properties","children":[2369,2370,2371,2373,2377,2372]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":160,"character":71,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L160"}]}}]},"permalink":"/api/cli#TaskContext","previousId":2400,"nextId":2401},{"id":2401,"name":"ThemePalette","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":194,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L194"}],"type":{"type":"mapped","parameter":"T","parameterType":{"type":"reference","target":2400,"name":"StyleType","package":"@boost/cli"},"templateType":{"type":"intrinsic","name":"string"}},"permalink":"/api/cli#ThemePalette","previousId":2367,"nextId":2250},{"id":2250,"name":"UnknownOptionMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":8,"character":12}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript"},"permalink":"/api/cli#UnknownOptionMap","previousId":2401,"nextId":2251},{"id":2251,"name":"ValueType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":6,"character":12}],"type":{"type":"union","types":[{"type":"reference","target":2156,"name":"ListType","package":"@boost/args"},{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}]},"permalink":"/api/cli#ValueType","previousId":2250,"nextId":2254},{"id":2254,"name":"Writeable","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":56,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L56"}],"typeParameters":[{"id":2255,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"mapped","parameter":"P","parameterType":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","target":2255,"name":"T","package":"@boost/cli","refersToTypeParameter":true}},"templateType":{"type":"indexedAccess","indexType":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/types.ts","qualifiedName":"P"},"name":"P","package":"@boost/cli","refersToTypeParameter":true},"objectType":{"type":"reference","target":2255,"name":"T","package":"@boost/cli","refersToTypeParameter":true}},"readonlyModifier":"-"},"permalink":"/api/cli#Writeable","previousId":2251,"nextId":1846},{"id":1846,"name":"CLIError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/CLIError.ts","line":26,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CLIError.ts#L26"}],"type":{"type":"reflection","declaration":{"id":1847,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":1848,"name":"new CLIError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":1849,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"COMMAND_DEFINED"},{"type":"literal","value":"COMMAND_INVALID_REGISTER"},{"type":"literal","value":"COMMAND_INVALID_RUN"},{"type":"literal","value":"COMMAND_INVALID_SUBPATH"},{"type":"literal","value":"COMMAND_MIXED_DEFAULT"},{"type":"literal","value":"COMMAND_MIXED_NONDEFAULT"},{"type":"literal","value":"COMMAND_NO_PROGRAM"},{"type":"literal","value":"COMMAND_NONE_REGISTERED"},{"type":"literal","value":"COMMAND_UNKNOWN"},{"type":"literal","value":"MIDDLEWARE_INVALID"},{"type":"literal","value":"OPTION_RESERVED"},{"type":"literal","value":"PARAMS_RUN_ONLY"},{"type":"literal","value":"REACT_RENDER_NO_NESTED"},{"type":"literal","value":"THEME_UNKNOWN"}]}},{"id":1850,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"COMMAND_DEFINED"},{"type":"literal","value":"COMMAND_INVALID_REGISTER"},{"type":"literal","value":"COMMAND_INVALID_RUN"},{"type":"literal","value":"COMMAND_INVALID_SUBPATH"},{"type":"literal","value":"COMMAND_MIXED_DEFAULT"},{"type":"literal","value":"COMMAND_MIXED_NONDEFAULT"},{"type":"literal","value":"COMMAND_NO_PROGRAM"},{"type":"literal","value":"COMMAND_NONE_REGISTERED"},{"type":"literal","value":"COMMAND_UNKNOWN"},{"type":"literal","value":"MIDDLEWARE_INVALID"},{"type":"literal","value":"OPTION_RESERVED"},{"type":"literal","value":"PARAMS_RUN_ONLY"},{"type":"literal","value":"REACT_RENDER_NO_NESTED"},{"type":"literal","value":"THEME_UNKNOWN"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/cli#CLIError","previousId":2254,"nextId":1966},{"id":1966,"name":"DELIMITER","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L37"}],"type":{"type":"literal","value":"$ "},"defaultValue":"\'$ \'","permalink":"/api/cli#DELIMITER","previousId":1846,"nextId":1957},{"id":1957,"name":"EXIT_FAIL","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":9,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L9"}],"type":{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"},"defaultValue":"1","permalink":"/api/cli#EXIT_FAIL","previousId":1966,"nextId":1956},{"id":1956,"name":"EXIT_PASS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":8,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L8"}],"type":{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"},"defaultValue":"0","permalink":"/api/cli#EXIT_PASS","previousId":1957,"nextId":1961},{"id":1961,"name":"INTERNAL_INITIALIZER","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":14,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L14"}],"type":{"type":"query","queryType":{"type":"reference","target":1961,"name":"INTERNAL_INITIALIZER","package":"@boost/cli"}},"defaultValue":"...","permalink":"/api/cli#INTERNAL_INITIALIZER","previousId":1956,"nextId":1958},{"id":1958,"name":"INTERNAL_OPTIONS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L11"}],"type":{"type":"query","queryType":{"type":"reference","target":1958,"name":"INTERNAL_OPTIONS","package":"@boost/cli"}},"defaultValue":"...","permalink":"/api/cli#INTERNAL_OPTIONS","previousId":1961,"nextId":1959},{"id":1959,"name":"INTERNAL_PARAMS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L12"}],"type":{"type":"query","queryType":{"type":"reference","target":1959,"name":"INTERNAL_PARAMS","package":"@boost/cli"}},"defaultValue":"...","permalink":"/api/cli#INTERNAL_PARAMS","previousId":1958,"nextId":1960},{"id":1960,"name":"INTERNAL_PROGRAM","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":13,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L13"}],"type":{"type":"query","queryType":{"type":"reference","target":1960,"name":"INTERNAL_PROGRAM","package":"@boost/cli"}},"defaultValue":"...","permalink":"/api/cli#INTERNAL_PROGRAM","previousId":1959,"nextId":1955},{"id":1955,"name":"LOCALE_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L6"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/cli#LOCALE_FORMAT","previousId":1960,"nextId":1962},{"id":1962,"name":"RESERVED_OPTIONS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":16,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L16"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"defaultValue":"...","permalink":"/api/cli#RESERVED_OPTIONS","previousId":1955,"nextId":1963},{"id":1963,"name":"SPACING_COL","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":33,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L33"}],"type":{"type":"literal","value":1},"defaultValue":"1","permalink":"/api/cli#SPACING_COL","previousId":1962,"nextId":1964},{"id":1964,"name":"SPACING_COL_WIDE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":34,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L34"}],"type":{"type":"literal","value":2},"defaultValue":"2","permalink":"/api/cli#SPACING_COL_WIDE","previousId":1963,"nextId":1965},{"id":1965,"name":"SPACING_ROW","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":35,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L35"}],"type":{"type":"literal","value":1},"defaultValue":"1","permalink":"/api/cli#SPACING_ROW","previousId":1964,"nextId":1954},{"id":1954,"name":"VERSION_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L4"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/cli#VERSION_FORMAT","previousId":1965},{"id":1787,"name":"Config","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Config.ts","line":16,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Config.ts#L16"}],"signatures":[{"id":1788,"name":"Config","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A class decorator for defining the following metadata on a "},{"kind":"code","text":"`Command`"},{"kind":"text","text":".\\n- path\\n- description\\n- aliases\\n- allowUnknownOptions\\n- allowVariadicParams\\n- categories\\n- category\\n- deprecated\\n- hidden\\n- usage"}]},"sources":[{"fileName":"packages/cli/src/decorators/Config.ts","line":16,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Config.ts#L16"}],"parameters":[{"id":1789,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1790,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1791,"name":"config","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2314,"name":"CommandStaticConfig","package":"@boost/cli"}],"name":"PartialConfig","package":"@boost/cli"}],"name":"Partial","package":"typescript"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"ClassDecorator"},"name":"ClassDecorator","package":"typescript"}}],"permalink":"/api/cli/function/Config","previousId":2033,"nextId":1967},{"id":1967,"name":"applyMarkdown","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/applyMarkdown.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/applyMarkdown.ts#L3"}],"signatures":[{"id":1968,"name":"applyMarkdown","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/applyMarkdown.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/applyMarkdown.ts#L3"}],"parameters":[{"id":1969,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/applyMarkdown","previousId":1787,"nextId":1970},{"id":1970,"name":"applyStyle","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/applyStyle.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/applyStyle.ts#L5"}],"signatures":[{"id":1971,"name":"applyStyle","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/applyStyle.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/applyStyle.ts#L5"}],"parameters":[{"id":1972,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1973,"name":"type","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2400,"name":"StyleType","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/applyStyle","previousId":1967,"nextId":2025},{"id":2025,"name":"checkNodeRequirement","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/middleware/checkNodeRequirement.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/middleware/checkNodeRequirement.ts#L8"}],"signatures":[{"id":2026,"name":"checkNodeRequirement","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Verify that the currently running Node.js process.version satisfies the given semver range.\\nIf not, a console error will be logged, or an error will be thrown."}]},"sources":[{"fileName":"packages/cli/src/middleware/checkNodeRequirement.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/middleware/checkNodeRequirement.ts#L8"}],"parameters":[{"id":2027,"name":"range","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2028,"name":"throws","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"reference","target":2394,"name":"Middleware","package":"@boost/cli"}}],"permalink":"/api/cli/function/checkNodeRequirement","previousId":1970,"nextId":2029},{"id":2029,"name":"checkPackageOutdated","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/middleware/checkPackageOutdated.ts","line":37,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/middleware/checkPackageOutdated.ts#L37"}],"signatures":[{"id":2030,"name":"checkPackageOutdated","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Verify that a package and its provided version is using the latest distribution\\nversion by checking against the npm registry. If not, a console message will be logged."}]},"sources":[{"fileName":"packages/cli/src/middleware/checkPackageOutdated.ts","line":37,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/middleware/checkPackageOutdated.ts#L37"}],"parameters":[{"id":2031,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2032,"name":"version","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":2394,"name":"Middleware","package":"@boost/cli"}}],"permalink":"/api/cli/function/checkPackageOutdated","previousId":2025,"nextId":1974},{"id":1974,"name":"formatCommandCall","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatCommandCall.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatCommandCall.ts#L4"}],"signatures":[{"id":1975,"name":"formatCommandCall","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatCommandCall.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatCommandCall.ts#L4"}],"parameters":[{"id":1976,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1977,"name":"metadata","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2292,"name":"CommandConfig","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/formatCommandCall","previousId":2029,"nextId":1978},{"id":1978,"name":"formatDescription","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L7"}],"signatures":[{"id":1979,"name":"formatDescription","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L7"}],"parameters":[{"id":1980,"name":"config","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":1981,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":1982,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":9,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L9"}],"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}},{"id":1983,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":10,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L10"}],"type":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},{"id":1985,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":12,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L12"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1984,"name":"description","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":11,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L11"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[1982,1983,1985,1984]}],"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":8,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L8"}]}}},{"id":1986,"name":"tags","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"defaultValue":"[]"}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/formatDescription","previousId":1974,"nextId":1987},{"id":1987,"name":"formatType","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L3"}],"signatures":[{"id":1988,"name":"formatType","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L3"}],"parameters":[{"id":1989,"name":"config","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":1990,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":1991,"name":"label","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":5,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L5"}],"type":{"type":"intrinsic","name":"string"}},{"id":1992,"name":"multiple","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":6,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L6"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1993,"name":"required","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":7,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L7"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1994,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":8,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L8"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[1991,1992,1993,1994]}],"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":4,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L4"}]}}},{"id":1995,"name":"inline","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/formatType","previousId":1978,"nextId":1996},{"id":1996,"name":"formatValue","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatValue.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatValue.ts#L3"}],"signatures":[{"id":1997,"name":"formatValue","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatValue.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatValue.ts#L3"}],"parameters":[{"id":1998,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/formatValue","previousId":1987,"nextId":1999},{"id":1999,"name":"getLongestWidth","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/getLongestWidth.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/getLongestWidth.ts#L3"}],"signatures":[{"id":2000,"name":"getLongestWidth","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/getLongestWidth.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/getLongestWidth.ts#L3"}],"parameters":[{"id":2001,"name":"values","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"intrinsic","name":"number"}}],"permalink":"/api/cli/function/getLongestWidth","previousId":1996,"nextId":2002},{"id":2002,"name":"groupByCategory","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"signatures":[{"id":2003,"name":"groupByCategory","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"typeParameter":[{"id":2004,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reflection","declaration":{"id":2005,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2006,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":44,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"type":{"type":"intrinsic","name":"string"}},{"id":2007,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":63,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2008,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":81,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2006,2007,2008]}],"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":42,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}]}}}],"parameters":[{"id":2009,"name":"items","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2004,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}},{"id":2010,"name":"categories","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"}}],"type":{"type":"reference","target":2011,"typeArguments":[{"type":"reference","target":2004,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"CategoryItemMap","package":"@boost/cli"}}],"permalink":"/api/cli/function/groupByCategory","previousId":1999,"nextId":2016},{"id":2016,"name":"isArgvSize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/isArgvSize.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/isArgvSize.ts#L4"}],"signatures":[{"id":2017,"name":"isArgvSize","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/isArgvSize.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/isArgvSize.ts#L4"}],"parameters":[{"id":2018,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}},{"id":2019,"name":"size","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/cli/function/isArgvSize","previousId":2002,"nextId":2020},{"id":2020,"name":"loadTheme","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/loadTheme.ts","line":10,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/loadTheme.ts#L10"}],"signatures":[{"id":2021,"name":"loadTheme","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/loadTheme.ts","line":10,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/loadTheme.ts#L10"}],"type":{"type":"reference","target":2401,"name":"ThemePalette","package":"@boost/cli"}}],"permalink":"/api/cli/function/loadTheme","previousId":2016,"nextId":2022},{"id":2022,"name":"mapCommandMetadata","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/mapCommandMetadata.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/mapCommandMetadata.ts#L3"}],"signatures":[{"id":2023,"name":"mapCommandMetadata","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/mapCommandMetadata.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/mapCommandMetadata.ts#L3"}],"parameters":[{"id":2024,"name":"commands","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}],"name":"Record","package":"typescript"}}],"type":{"type":"reference","target":2343,"name":"CommandMetadataMap","package":"@boost/cli"}}],"permalink":"/api/cli/function/mapCommandMetadata","previousId":2020,"nextId":2135}],"groups":[{"title":"Classes","children":[1851,2033]},{"title":"Functions","children":[1787,1967,1970,2025,2029,1974,1978,1987,1996,1999,2002,2016,2020,2022]},{"title":"Interfaces","children":[2135,2145,2292,2328,2314,2344,2148,2256,2157,2176,2306,2201,2220,2283,2271,2279,2231]},{"title":"Namespaces","children":[1792]},{"title":"Type Aliases","children":[2134,2144,1845,2264,2011,2305,2343,2291,2265,2266,2156,2394,2389,2390,2193,2200,2260,2218,2219,2262,2252,2229,2287,2290,2230,2400,2367,2401,2250,2251,2254]},{"title":"Variables","children":[1846,1966,1957,1956,1961,1958,1959,1960,1955,1962,1963,1964,1965,1954]}],"sources":[{"fileName":"packages/cli/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/index.ts#L1"}],"permalink":"/api/cli"},"urlSlug":"cli"},{"index":false,"label":"Components & hooks","reflection":{"id":10,"name":"@boost/cli/react","variant":"declaration","kind":2,"flags":{},"children":[{"id":2422,"name":"Failure","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a failure state for errors and warnings."}]},"children":[{"id":2423,"name":"constructor","variant":"declaration","kind":512,"flags":{"isExternal":true},"sources":[{"fileName":"node_modules/@types/react/index.d.ts","line":941,"character":8},{"fileName":"node_modules/@types/react/index.d.ts","line":946,"character":8}],"signatures":[{"id":2424,"name":"new Failure","variant":"signature","kind":16384,"flags":{"isExternal":true},"sources":[{"fileName":"node_modules/@types/react/index.d.ts","line":941,"character":8}],"parameters":[{"id":2425,"name":"props","variant":"param","kind":32768,"flags":{"isExternal":true},"type":{"type":"union","types":[{"type":"reference","target":2415,"name":"FailureProps","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":2415,"name":"FailureProps","package":"@boost/cli"}],"name":"Readonly","package":"typescript"}]}}],"type":{"type":"reference","target":2422,"name":"Failure","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"Component.constructor"}},{"id":2426,"name":"new Failure","variant":"signature","kind":16384,"flags":{"isExternal":true},"comment":{"summary":[],"blockTags":[{"tag":"@deprecated","content":[]},{"tag":"@see","content":[{"kind":"inline-tag","tag":"@link","text":"React Docs","target":"https://legacy.reactjs.org/docs/legacy-context.html"}]}]},"sources":[{"fileName":"node_modules/@types/react/index.d.ts","line":946,"character":8}],"parameters":[{"id":2427,"name":"props","variant":"param","kind":32768,"flags":{"isExternal":true},"type":{"type":"reference","target":2415,"name":"FailureProps","package":"@boost/cli"}},{"id":2428,"name":"context","variant":"param","kind":32768,"flags":{"isExternal":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","target":2422,"name":"Failure","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"Component.constructor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Component.constructor"}},{"id":2437,"name":"render","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":152,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L152"}],"signatures":[{"id":2438,"name":"render","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":152,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L152"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"},"overwrites":{"type":"reference","target":-1,"name":"Component.render"}}],"overwrites":{"type":"reference","target":-1,"name":"Component.render"}},{"id":2431,"name":"renderCodeFrame","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L50"}],"signatures":[{"id":2432,"name":"renderCodeFrame","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L50"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}]}}]},{"id":2433,"name":"renderStackTrace","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L105"}],"signatures":[{"id":2434,"name":"renderStackTrace","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L105"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}]}}]},{"id":2435,"name":"renderWarnings","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L127"}],"signatures":[{"id":2436,"name":"renderWarnings","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L127"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}]}}]},{"id":2429,"name":"shouldHideStackTrace","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L36"}],"signatures":[{"id":2430,"name":"shouldHideStackTrace","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L36"}],"type":{"type":"intrinsic","name":"boolean"}}]}],"groups":[{"title":"Constructors","children":[2423]},{"title":"Methods","children":[2437,2431,2433,2435,2429]}],"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":35,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L35"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.Component"},"typeArguments":[{"type":"reference","target":2415,"name":"FailureProps","package":"@boost/cli"}],"name":"Component","package":"@types/react","qualifiedName":"React.Component"}],"permalink":"/api/cli-react/class/Failure","nextId":2402},{"id":2405,"name":"ConfirmProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2406,"name":"invalidError","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Error message to display when an invalid character is pressed. Defaults to a custom message."}]},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L12"}],"type":{"type":"intrinsic","name":"string"}},{"id":2409,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label to display before or above the prompt itself."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.label"}},{"id":2407,"name":"no","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Character that triggers a falsy state when pressed. Defaults to \\"N\\"."}]},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L14"}],"type":{"type":"intrinsic","name":"string"}},{"id":2411,"name":"onSubmit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"type":{"type":"reflection","declaration":{"id":2412,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"signatures":[{"id":2413,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"parameters":[{"id":2414,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.onSubmit"}},{"id":2410,"name":"prefix","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character symbol to display before the label. Defaults to \\"?\\"\\"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L14"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.prefix"}},{"id":2408,"name":"yes","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Character that triggers a truthy state when pressed. Defaults to \\"y\\"."}]},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L16"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2406,2409,2407,2411,2410,2408]}],"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":10,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L10"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/Prompt.tsx","qualifiedName":"PromptProps"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"PromptProps","package":"@boost/cli"},{"type":"literal","value":"validate"}],"name":"Omit","package":"typescript"}],"permalink":"/api/cli-react/interface/ConfirmProps","previousId":2604,"nextId":2415},{"id":2415,"name":"FailureProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2416,"name":"binName","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Name of the binary being executed."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L19"}],"type":{"type":"intrinsic","name":"string"}},{"id":2417,"name":"commandLine","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Full length command line being ran."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L21"}],"type":{"type":"intrinsic","name":"string"}},{"id":2418,"name":"delimiter","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Delimiter to prefix within examples. Defaults to \\"$ \\"."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L23"}],"type":{"type":"intrinsic","name":"string"}},{"id":2419,"name":"error","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The primary error to display in red."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L25"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}},{"id":2420,"name":"hideStackTrace","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Hide the primary error stack trace. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L27"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2421,"name":"warnings","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Optional errors as warnings to display in yellow."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L29"}],"type":{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}}],"groups":[{"title":"Properties","children":[2416,2417,2418,2419,2420,2421]}],"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":17,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L17"}],"permalink":"/api/cli-react/interface/FailureProps","previousId":2405,"nextId":2442},{"id":2442,"name":"HeaderProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2443,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Text to display for the label."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L8"}],"type":{"type":"intrinsic","name":"string"}},{"id":2445,"name":"marginBottom","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The top margin. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L12"}],"type":{"type":"intrinsic","name":"number"}},{"id":2444,"name":"marginTop","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The bottom margin. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L10"}],"type":{"type":"intrinsic","name":"number"}},{"id":2446,"name":"type","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Customize the background color using Style. Defaults to normal text."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L14"}],"type":{"type":"union","types":[{"type":"reference","target":2400,"name":"StyleType","package":"@boost/cli"},{"type":"literal","value":"none"}]}}],"groups":[{"title":"Properties","children":[2443,2445,2444,2446]}],"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":6,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L6"}],"permalink":"/api/cli-react/interface/HeaderProps","previousId":2415,"nextId":2450},{"id":2450,"name":"HelpProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2451,"name":"categories","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mapping of categories to use for command and option grouping."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L32"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"}},{"id":2453,"name":"commands","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mapping of commands, typically sub-commands."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L36"}],"type":{"type":"reference","target":2305,"name":"CommandConfigMap","package":"@boost/cli"}},{"id":2452,"name":"config","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Configuration metadata about the current command."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L34"}],"type":{"type":"reference","target":2292,"name":"CommandConfig","package":"@boost/cli"}},{"id":2454,"name":"delimiter","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Delimiter to prefix within examples. Defaults to \\"$ \\"."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L38"}],"type":{"type":"intrinsic","name":"string"}},{"id":2455,"name":"header","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A header to display at the top of the output."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":40,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L40"}],"type":{"type":"intrinsic","name":"string"}},{"id":2456,"name":"options","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mapping of command options."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L42"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"}},{"id":2457,"name":"params","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of command params."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":44,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L44"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"}}],"groups":[{"title":"Properties","children":[2451,2453,2452,2454,2455,2456,2457]}],"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":30,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L30"}],"permalink":"/api/cli-react/interface/HelpProps","previousId":2442,"nextId":2465},{"id":2465,"name":"IndexHelpProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2467,"name":"banner","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A large banner to appear at the top of the index help interface."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L78"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2272,"name":"ProgramOptions.banner"}},{"id":2468,"name":"bin","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The name of the binary consumers enter on the command line. Must be in kebab-case."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":80,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L80"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2273,"name":"ProgramOptions.bin"}},{"id":2466,"name":"children","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/components/IndexHelp.tsx","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/IndexHelp.tsx#L8"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}},{"id":2469,"name":"delimiter","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The character(s) displayed before command line usage examples."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":82,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L82"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2274,"name":"ProgramOptions.delimiter"}},{"id":2470,"name":"footer","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A string of text to display at the bottom of the index help interface."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L84"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2275,"name":"ProgramOptions.footer"}},{"id":2471,"name":"header","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A string of text to display at the top of the index help interface, below the banner (if present)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":86,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L86"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2276,"name":"ProgramOptions.header"}},{"id":2472,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A human readable name for your program."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":88,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L88"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2277,"name":"ProgramOptions.name"}},{"id":2473,"name":"version","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current version of your CLI program. Typically the version found in your "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":". This is output when "},{"kind":"code","text":"`--version`"},{"kind":"text","text":" is passed."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L90"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2278,"name":"ProgramOptions.version"}}],"groups":[{"title":"Properties","children":[2467,2468,2466,2469,2470,2471,2472,2473]}],"sources":[{"fileName":"packages/cli/src/components/IndexHelp.tsx","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/IndexHelp.tsx#L7"}],"extendedTypes":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"permalink":"/api/cli-react/interface/IndexHelpProps","previousId":2450,"nextId":2477},{"id":2477,"name":"InputProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2478,"name":"defaultValue","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A default value. If none provided, will use an empty state."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L9"}],"type":{"type":"intrinsic","name":"string"}},{"id":2479,"name":"hideCursor","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Hide the cursor in the terminal. Will remove the background color, but still functions."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L11"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2486,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label to display before or above the prompt itself."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.label"}},{"id":2480,"name":"mask","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mask to replace every inputted character with."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L13"}],"type":{"type":"intrinsic","name":"string"}},{"id":2481,"name":"onChange","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value changes."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L15"}],"type":{"type":"reflection","declaration":{"id":2482,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L15"}],"signatures":[{"id":2483,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value changes."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L15"}],"parameters":[{"id":2484,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2488,"name":"onSubmit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"type":{"type":"reflection","declaration":{"id":2489,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"signatures":[{"id":2490,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"parameters":[{"id":2491,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.onSubmit"}},{"id":2485,"name":"placeholder","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom string to display when the value is empty and non-dirty."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L17"}],"type":{"type":"intrinsic","name":"string"}},{"id":2487,"name":"prefix","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character symbol to display before the label. Defaults to \\"?\\"\\"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L14"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.prefix"}},{"id":2492,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"type":{"type":"reflection","declaration":{"id":2493,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"signatures":[{"id":2494,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"parameters":[{"id":2495,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.validate"}}],"groups":[{"title":"Properties","children":[2478,2479,2486,2480,2481,2488,2485,2487,2492]}],"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L7"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/Prompt.tsx","qualifiedName":"PromptProps"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"PromptProps","package":"@boost/cli"}],"permalink":"/api/cli-react/interface/InputProps","previousId":2465,"nextId":2500},{"id":2500,"name":"MultiSelectProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2501,"name":"defaultSelected","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of option values selected by default."}]},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L15"}],"type":{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}},"overwrites":{"type":"reference","target":2549,"name":"SelectProps.defaultSelected"}},{"id":2507,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label to display before or above the prompt itself."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"},"inheritedFrom":{"type":"reference","target":2551,"name":"SelectProps.label"}},{"id":2517,"name":"limit","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Number of options to display before scrolling. Defaults to console height."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L16"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":2561,"name":"SelectProps.limit"}},{"id":2502,"name":"onChange","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback triggered when a value is selected or unselected."}]},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L17"}],"type":{"type":"reflection","declaration":{"id":2503,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":17,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L17"}],"signatures":[{"id":2504,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when a value is selected or unselected."}]},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":17,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L17"}],"parameters":[{"id":2505,"name":"values","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2509,"name":"onSubmit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"type":{"type":"reflection","declaration":{"id":2510,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"signatures":[{"id":2511,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"parameters":[{"id":2512,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":2553,"name":"SelectProps.onSubmit"}},{"id":2506,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of options to choose from. Can either be a string, number, or object with a "},{"kind":"code","text":"`label`"},{"kind":"text","text":" and "},{"kind":"code","text":"`value`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L27"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true},{"type":"reference","target":2534,"typeArguments":[{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}],"name":"SelectOptionLike","package":"@boost/cli"}]}},"inheritedFrom":{"type":"reference","target":2550,"name":"SelectProps.options"}},{"id":2518,"name":"overflowAfterLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label to display above scrollable options with the number of overflowing options."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"OverflowLabel"},"name":"OverflowLabel","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":2562,"name":"SelectProps.overflowAfterLabel"}},{"id":2519,"name":"overflowBeforeLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label to display below scrollable options with the number of overflowing options."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L20"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"OverflowLabel"},"name":"OverflowLabel","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":2563,"name":"SelectProps.overflowBeforeLabel"}},{"id":2508,"name":"prefix","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character symbol to display before the label. Defaults to \\"?\\"\\"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L14"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2552,"name":"SelectProps.prefix"}},{"id":2520,"name":"scrollType","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The pattern in which to limit options when scrolling. Defaults to "},{"kind":"code","text":"`overflow`"},{"kind":"text","text":".\\n- "},{"kind":"code","text":"`cycle`"},{"kind":"text","text":" - Will continously cycle through options, even when navigating to and past edges.\\n- "},{"kind":"code","text":"`overflow`"},{"kind":"text","text":" - Will display options bound to an edge, with the number of options hidden above and below."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L26"}],"type":{"type":"union","types":[{"type":"literal","value":"cycle"},{"type":"literal","value":"overflow"}]},"inheritedFrom":{"type":"reference","target":2564,"name":"SelectProps.scrollType"}},{"id":2513,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"type":{"type":"reflection","declaration":{"id":2514,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"signatures":[{"id":2515,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"parameters":[{"id":2516,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":2557,"name":"SelectProps.validate"}}],"groups":[{"title":"Properties","children":[2501,2507,2517,2502,2509,2506,2518,2519,2508,2520,2513]}],"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":13,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L13"}],"typeParameters":[{"id":2521,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"extendedTypes":[{"type":"reference","target":2548,"typeArguments":[{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}},{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}],"name":"SelectProps","package":"@boost/cli"}],"permalink":"/api/cli-react/interface/MultiSelectProps","previousId":2477,"nextId":2542},{"id":2542,"name":"SelectOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":2543,"name":"divider","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L17"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2544,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L18"}],"type":{"type":"intrinsic","name":"number"}},{"id":2545,"name":"label","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L19"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"}},{"id":2546,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L20"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":2547,"name":"T","package":"@boost/cli","qualifiedName":"SelectOption.T","refersToTypeParameter":true}]}}],"groups":[{"title":"Properties","children":[2543,2544,2545,2546]}],"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":16,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L16"}],"typeParameters":[{"id":2547,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/cli-react/interface/SelectOption","previousId":2500,"nextId":2548},{"id":2548,"name":"SelectProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2549,"name":"defaultSelected","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Option value selected by default."}]},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L25"}],"type":{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}},{"id":2551,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label to display before or above the prompt itself."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.label"}},{"id":2561,"name":"limit","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Number of options to display before scrolling. Defaults to console height."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L16"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":-1,"name":"ScrollableListProps.limit"}},{"id":2553,"name":"onSubmit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"type":{"type":"reflection","declaration":{"id":2554,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"signatures":[{"id":2555,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"parameters":[{"id":2556,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.onSubmit"}},{"id":2550,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of options to choose from. Can either be a string, number, or object with a "},{"kind":"code","text":"`label`"},{"kind":"text","text":" and "},{"kind":"code","text":"`value`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L27"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","target":2566,"name":"V","package":"@boost/cli","qualifiedName":"SelectProps.V","refersToTypeParameter":true},{"type":"reference","target":2534,"typeArguments":[{"type":"reference","target":2566,"name":"V","package":"@boost/cli","qualifiedName":"SelectProps.V","refersToTypeParameter":true}],"name":"SelectOptionLike","package":"@boost/cli"}]}}},{"id":2562,"name":"overflowAfterLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label to display above scrollable options with the number of overflowing options."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"OverflowLabel"},"name":"OverflowLabel","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"ScrollableListProps.overflowAfterLabel"}},{"id":2563,"name":"overflowBeforeLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label to display below scrollable options with the number of overflowing options."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L20"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"OverflowLabel"},"name":"OverflowLabel","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"ScrollableListProps.overflowBeforeLabel"}},{"id":2552,"name":"prefix","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character symbol to display before the label. Defaults to \\"?\\"\\"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L14"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.prefix"}},{"id":2564,"name":"scrollType","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The pattern in which to limit options when scrolling. Defaults to "},{"kind":"code","text":"`overflow`"},{"kind":"text","text":".\\n- "},{"kind":"code","text":"`cycle`"},{"kind":"text","text":" - Will continously cycle through options, even when navigating to and past edges.\\n- "},{"kind":"code","text":"`overflow`"},{"kind":"text","text":" - Will display options bound to an edge, with the number of options hidden above and below."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L26"}],"type":{"type":"union","types":[{"type":"literal","value":"cycle"},{"type":"literal","value":"overflow"}]},"inheritedFrom":{"type":"reference","target":-1,"name":"ScrollableListProps.scrollType"}},{"id":2557,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"type":{"type":"reflection","declaration":{"id":2558,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"signatures":[{"id":2559,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"parameters":[{"id":2560,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.validate"}}],"groups":[{"title":"Properties","children":[2549,2551,2561,2553,2550,2562,2563,2552,2564,2557]}],"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":23,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L23"}],"typeParameters":[{"id":2565,"name":"T","variant":"typeParam","kind":131072,"flags":{}},{"id":2566,"name":"V","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/Prompt.tsx","qualifiedName":"PromptProps"},"typeArguments":[{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}],"name":"PromptProps","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"ScrollableListProps"},"name":"ScrollableListProps","package":"@boost/cli"}],"extendedBy":[{"type":"reference","target":2500,"name":"MultiSelectProps"}],"permalink":"/api/cli-react/interface/SelectProps","previousId":2542,"nextId":2570},{"id":2570,"name":"StyleProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2571,"name":"children","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"}},{"id":2572,"name":"inverted","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Invert the colors to style the background instead of foreground. Defaults\\nto "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L10"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2573,"name":"type","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Theme palette name to style with. Defaults to \\"none\\"."}]},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L12"}],"type":{"type":"union","types":[{"type":"reference","target":2400,"name":"StyleType","package":"@boost/cli"},{"type":"literal","value":"none"}]}}],"groups":[{"title":"Properties","children":[2571,2572,2573]}],"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":6,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L6"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Pick"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/ink/build/components/Text.d.ts","qualifiedName":"Props"},"name":"TextProps","package":"ink","qualifiedName":"Props"},{"type":"union","types":[{"type":"literal","value":"bold"},{"type":"literal","value":"italic"},{"type":"literal","value":"underline"},{"type":"literal","value":"wrap"}]}],"name":"Pick","package":"typescript"}],"permalink":"/api/cli-react/interface/StyleProps","previousId":2548,"nextId":2461},{"id":2461,"name":"HiddenInputProps","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/components/HiddenInput.tsx","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/HiddenInput.tsx#L3"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2477,"name":"InputProps","package":"@boost/cli"},{"type":"union","types":[{"type":"literal","value":"hideCursor"},{"type":"literal","value":"mask"}]}],"name":"Omit","package":"typescript"},"permalink":"/api/cli-react#HiddenInputProps","previousId":2570,"nextId":2525},{"id":2525,"name":"PasswordInputProps","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/components/PasswordInput.tsx","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/PasswordInput.tsx#L3"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2477,"name":"InputProps","package":"@boost/cli"},{"type":"literal","value":"mask"}],"name":"Omit","package":"typescript"},"permalink":"/api/cli-react#PasswordInputProps","previousId":2461,"nextId":2534},{"id":2534,"name":"SelectOptionLike","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":12,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L12"}],"typeParameters":[{"id":2541,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2535,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2536,"name":"divider","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":13,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L13"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2537,"name":"label","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":13,"character":23,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L13"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"}}],"groups":[{"title":"Properties","children":[2536,2537]}],"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":13,"character":3,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L13"}]}},{"type":"reflection","declaration":{"id":2538,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2539,"name":"label","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":14,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L14"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"}},{"id":2540,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":14,"character":36,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L14"}],"type":{"type":"reference","target":2541,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[2539,2540]}],"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":14,"character":3,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L14"}]}}]},"permalink":"/api/cli-react#SelectOptionLike","previousId":2525,"nextId":2609},{"id":2609,"name":"ProgramContext","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/ProgramContext.ts","line":5,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/ProgramContext.ts#L5"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.Context"},"typeArguments":[{"type":"reference","target":2283,"name":"ProgramContextType","package":"@boost/cli"}],"name":"Context","package":"@types/react","qualifiedName":"React.Context"},"defaultValue":"...","permalink":"/api/cli-react#ProgramContext","previousId":2534},{"id":2402,"name":"Confirm","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":22,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L22"}],"signatures":[{"id":2403,"name":"Confirm","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a yes/no confirmation prompt."}]},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":22,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L22"}],"parameters":[{"id":2404,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2405,"name":"ConfirmProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Confirm","previousId":2422,"nextId":2439},{"id":2439,"name":"Header","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L20"}],"signatures":[{"id":2440,"name":"Header","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a header/title within a terminal menu."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L20"}],"parameters":[{"id":2441,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2442,"name":"HeaderProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Header","previousId":2402,"nextId":2447},{"id":2447,"name":"Help","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":52,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L52"}],"signatures":[{"id":2448,"name":"Help","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a help menu for a command.\\nIncludes all sub-commands, options, params, and more."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":52,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L52"}],"parameters":[{"id":2449,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2450,"name":"HelpProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Help","previousId":2439,"nextId":2458},{"id":2458,"name":"HiddenInput","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/HiddenInput.tsx","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/HiddenInput.tsx#L8"}],"signatures":[{"id":2459,"name":"HiddenInput","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders an input field that hides its content from the terminal."}]},"sources":[{"fileName":"packages/cli/src/components/HiddenInput.tsx","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/HiddenInput.tsx#L8"}],"parameters":[{"id":2460,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2461,"name":"HiddenInputProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/HiddenInput","previousId":2447,"nextId":2462},{"id":2462,"name":"IndexHelp","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/IndexHelp.tsx","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/IndexHelp.tsx#L14"}],"signatures":[{"id":2463,"name":"IndexHelp","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a help menu for the entire program."}]},"sources":[{"fileName":"packages/cli/src/components/IndexHelp.tsx","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/IndexHelp.tsx#L14"}],"parameters":[{"id":2464,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2465,"name":"IndexHelpProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/IndexHelp","previousId":2458,"nextId":2474},{"id":2474,"name":"Input","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L23"}],"signatures":[{"id":2475,"name":"Input","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders an input field, allowing the user to enter information."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L23"}],"parameters":[{"id":2476,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2477,"name":"InputProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Input","previousId":2462,"nextId":2496},{"id":2496,"name":"MultiSelect","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L24"}],"signatures":[{"id":2497,"name":"MultiSelect","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a select menu with options, where multiple options can be seleted.\\nOptions can be navigated with arrow keys, selected with \\"space\\", and submitted with \\"enter\\"."}]},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L24"}],"typeParameter":[{"id":2498,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2499,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2500,"typeArguments":[{"type":"reference","target":2498,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MultiSelectProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/MultiSelect","previousId":2474,"nextId":2522},{"id":2522,"name":"PasswordInput","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/PasswordInput.tsx","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/PasswordInput.tsx#L8"}],"signatures":[{"id":2523,"name":"PasswordInput","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders an input field with characters masked with \\"*\\"."}]},"sources":[{"fileName":"packages/cli/src/components/PasswordInput.tsx","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/PasswordInput.tsx#L8"}],"parameters":[{"id":2524,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2525,"name":"PasswordInputProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/PasswordInput","previousId":2496,"nextId":2530},{"id":2530,"name":"Select","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":55,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L55"}],"signatures":[{"id":2531,"name":"Select","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a select menu with options, where a single option can be seleted.\\nOptions can be navigated with arrow keys, selected with \\"space\\", and submitted with \\"enter\\"."}]},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":55,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L55"}],"typeParameter":[{"id":2532,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":2533,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2548,"typeArguments":[{"type":"reference","target":2532,"name":"T","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":2532,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"SelectProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Select","previousId":2522,"nextId":2567},{"id":2567,"name":"Style","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":18,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L18"}],"signatures":[{"id":2568,"name":"Style","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that styles text and backgrounds based on the current Boost theme."}]},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":18,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L18"}],"parameters":[{"id":2569,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2570,"name":"StyleProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Style","previousId":2530,"nextId":2526},{"id":2526,"name":"normalizeOptions","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":30,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L30"}],"signatures":[{"id":2527,"name":"normalizeOptions","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":30,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L30"}],"typeParameter":[{"id":2528,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2529,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"array","elementType":{"type":"reference","target":2542,"typeArguments":[{"type":"reference","target":2528,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"SelectOption","package":"@boost/cli"}}}],"permalink":"/api/cli-react/function/normalizeOptions","previousId":2567,"nextId":2574},{"id":2574,"name":"useDimensions","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}],"signatures":[{"id":2575,"name":"useDimensions","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}],"type":{"type":"reflection","declaration":{"id":2576,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2577,"name":"height","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}],"type":{"type":"intrinsic","name":"number"}},{"id":2578,"name":"width","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":51,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[2577,2578]}],"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":33,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}]}}}],"permalink":"/api/cli-react/function/useDimensions","previousId":2526,"nextId":2579},{"id":2579,"name":"useIsMounted","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useIsMounted.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useIsMounted.ts#L3"}],"signatures":[{"id":2580,"name":"useIsMounted","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useIsMounted.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useIsMounted.ts#L3"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.MutableRefObject"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"MutableRefObject","package":"@types/react","qualifiedName":"React.MutableRefObject"}}],"permalink":"/api/cli-react/function/useIsMounted","previousId":2574,"nextId":2581},{"id":2581,"name":"useListNavigation","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L3"}],"signatures":[{"id":2582,"name":"useListNavigation","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L3"}],"parameters":[{"id":2583,"name":"list","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reflection","declaration":{"id":2584,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2585,"name":"disabled","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":4,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L4"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2586,"name":"divider","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":4,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L4"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2585,2586]}],"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":4,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L4"}]}}}},{"id":2587,"name":"defaultIndex","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reflection","declaration":{"id":2588,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2589,"name":"highlightedIndex","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":48,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L48"}],"type":{"type":"intrinsic","name":"number"}},{"id":2590,"name":"onKeyDown","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":49,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L49"}],"type":{"type":"reflection","declaration":{"id":2591,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":31,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L31"}],"signatures":[{"id":2592,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":31,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L31"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2593,"name":"onKeyLeft","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":50,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L50"}],"type":{"type":"reflection","declaration":{"id":2594,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":39,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L39"}],"signatures":[{"id":2595,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":39,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L39"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2596,"name":"onKeyRight","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":51,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L51"}],"type":{"type":"reflection","declaration":{"id":2597,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":43,"character":32,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L43"}],"signatures":[{"id":2598,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":43,"character":32,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L43"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2599,"name":"onKeyUp","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":52,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L52"}],"type":{"type":"reflection","declaration":{"id":2600,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":35,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L35"}],"signatures":[{"id":2601,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":35,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L35"}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[2589,2590,2593,2596,2599]}],"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":47,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L47"}]}}}],"permalink":"/api/cli-react/function/useListNavigation","previousId":2579,"nextId":2602},{"id":2602,"name":"useProgram","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useProgram.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useProgram.ts#L8"}],"signatures":[{"id":2603,"name":"useProgram","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useProgram.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useProgram.ts#L8"}],"type":{"type":"reference","target":2283,"name":"ProgramContextType","package":"@boost/cli"}}],"permalink":"/api/cli-react/function/useProgram","previousId":2581,"nextId":2604},{"id":2604,"name":"useRenderLoop","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useRenderLoop.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useRenderLoop.ts#L5"}],"signatures":[{"id":2605,"name":"useRenderLoop","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useRenderLoop.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useRenderLoop.ts#L5"}],"parameters":[{"id":2606,"name":"fps","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"},"defaultValue":"30"}],"type":{"type":"reflection","declaration":{"id":2607,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useRenderLoop.ts","line":5,"character":49,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useRenderLoop.ts#L5"}],"signatures":[{"id":2608,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"void"}}]}}}],"permalink":"/api/cli-react/function/useRenderLoop","previousId":2602,"nextId":2405}],"groups":[{"title":"Classes","children":[2422]},{"title":"Functions","children":[2402,2439,2447,2458,2462,2474,2496,2522,2530,2567,2526,2574,2579,2581,2602,2604]},{"title":"Interfaces","children":[2405,2415,2442,2450,2465,2477,2500,2542,2548,2570]},{"title":"Type Aliases","children":[2461,2525,2534]},{"title":"Variables","children":[2609]}],"sources":[{"fileName":"packages/cli/src/react.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/react.ts#L1"}],"permalink":"/api/cli-react"},"urlSlug":"cli-react"},{"index":false,"label":"Test utilities","reflection":{"id":11,"name":"@boost/cli/test","variant":"declaration","kind":2,"flags":{},"children":[{"id":54,"name":"MockReadStream","variant":"declaration","kind":128,"flags":{},"children":[{"id":55,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":56,"name":"new MockReadStream","variant":"signature","kind":16384,"flags":{},"type":{"type":"reference","target":54,"name":"MockReadStream","package":"@boost/cli"}}]},{"id":57,"name":"isTTY","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L20"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"groups":[{"title":"Constructors","children":[55]},{"title":"Properties","children":[57]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":19,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L19"}],"permalink":"/api/cli-test/class/MockReadStream","nextId":58},{"id":58,"name":"MockWriteStream","variant":"declaration","kind":128,"flags":{},"children":[{"id":59,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L30"}],"signatures":[{"id":60,"name":"new MockWriteStream","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L30"}],"parameters":[{"id":61,"name":"append","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"reference","target":58,"name":"MockWriteStream","package":"@boost/cli"}}]},{"id":62,"name":"append","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L24"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":63,"name":"columns","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L26"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"80"},{"id":64,"name":"output","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L28"}],"type":{"type":"intrinsic","name":"string"}},{"id":68,"name":"get","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L43"}],"signatures":[{"id":69,"name":"get","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L43"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":72,"name":"off","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":49,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L49"}],"signatures":[{"id":73,"name":"off","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":49,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L49"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":70,"name":"on","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L47"}],"signatures":[{"id":71,"name":"on","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L47"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":65,"name":"write","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L35"}],"signatures":[{"id":66,"name":"write","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L35"}],"parameters":[{"id":67,"name":"string","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Constructors","children":[59]},{"title":"Properties","children":[62,63,64]},{"title":"Methods","children":[68,72,70,65]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":23,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L23"}],"permalink":"/api/cli-test/class/MockWriteStream","previousId":54,"nextId":15},{"id":15,"name":"mockProgram","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L80"}],"signatures":[{"id":16,"name":"mockProgram","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a "},{"kind":"code","text":"`Program`"},{"kind":"text","text":" instance with required options pre-filled and streams mocked\\n(unless manually provided).\\n\\n"},{"kind":"code","text":"```ts\\nimport { mockProgram } from \'@boost/cli/test\';\\n\\nconst program = mockProgram({ name: \'Example\' });\\n```"}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L80"}],"parameters":[{"id":17,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Partial","package":"typescript"}},{"id":18,"name":"streams","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2279,"name":"ProgramStreams","package":"@boost/cli"}}],"type":{"type":"reference","target":2033,"name":"Program","package":"@boost/cli"}}],"permalink":"/api/cli-test/function/mockProgram","previousId":58,"nextId":12},{"id":12,"name":"mockStreams","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":62,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L62"}],"signatures":[{"id":13,"name":"mockStreams","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns mocked "},{"kind":"code","text":"`stderr`"},{"kind":"text","text":", "},{"kind":"code","text":"`stdout`"},{"kind":"text","text":", and "},{"kind":"code","text":"`stdin`"},{"kind":"text","text":" streams that can be passed to a "},{"kind":"code","text":"`Program`"},{"kind":"text","text":".\\nThis does not mock all stream functionality, only those required by Boost and Ink.\\n\\n"},{"kind":"code","text":"```ts\\nimport { mockStreams } from \'@boost/cli/test\';\\n\\nconst streams = mockStreams();\\n```"}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":62,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L62"}],"parameters":[{"id":14,"name":"append","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":2279,"name":"ProgramStreams","package":"@boost/cli"}}],"permalink":"/api/cli-test/function/mockStreams","previousId":15,"nextId":19},{"id":19,"name":"renderComponent","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":109,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L109"}],"signatures":[{"id":20,"name":"renderComponent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to render a React component with Ink and return the rendered result\\nas a terminal compatible string. If "},{"kind":"code","text":"`stripped`"},{"kind":"text","text":" is true, it will strip ANSI\\nescape escape sequences.\\n\\n"},{"kind":"code","text":"```tsx\\nimport { renderComponent } from \'@boost/cli/test\';\\nimport TestComponent from \'../src/components/TestComponent\';\\n\\nit(\'renders a component\', async () => {\\n\\texpect(await renderComponent()).toMatchSnapshot();\\n});\\n```"},{"kind":"text","text":"\\n\\n> As an alternative, we also suggest using the official\\n> [ink-testing-library](https://github.com/vadimdemedes/ink-testing-library)."}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":109,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L109"}],"parameters":[{"id":21,"name":"element","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}},{"id":22,"name":"stripped","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/cli-test/function/renderComponent","previousId":12,"nextId":23},{"id":23,"name":"runCommand","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":155,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L155"}],"signatures":[{"id":24,"name":"runCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Runs a "},{"kind":"code","text":"`Command`"},{"kind":"text","text":" outside the context of a "},{"kind":"code","text":"`Program`"},{"kind":"text","text":", but mimics similar functionality,\\nincluding React component rendering. Params are required as they\'re passed to the run method,\\nwhile options are optional and assume class properties have been defined. Also, the "},{"kind":"code","text":"`exit`"},{"kind":"text","text":"\\nand "},{"kind":"code","text":"`log`"},{"kind":"text","text":" methods have been mocked with Vitest spies so that they can be asserted.\\n\\n"},{"kind":"code","text":"```ts\\nimport { runCommand } from \'@boost/cli/test\';\\nimport TestCommand from \'../src/commands/TestCommand\';\\n\\nit(\'runs a command\', async () => {\\n\\tconst command = new TestCommand();\\n\\n\\texpect(await runCommand(command, [\'foo\', \'bar\', \'baz\'])).toMatchSnapshot();\\n\\texpect(command.log).toHaveBeenCalled();\\n});\\n```"},{"kind":"text","text":"\\n\\n> Since there is no "},{"kind":"code","text":"`Program`"},{"kind":"text","text":" context, any functionality that requires a program will fail. If\\n> needed, use "},{"kind":"code","text":"`runProgram()`"},{"kind":"text","text":" instead."}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":155,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L155"}],"typeParameter":[{"id":25,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}},{"id":26,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}}],"parameters":[{"id":27,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1851,"typeArguments":[{"type":"reference","target":25,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":26,"name":"P","package":"@boost/cli","refersToTypeParameter":true},{"type":"reflection","declaration":{"id":28,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Command","package":"@boost/cli"}},{"id":29,"name":"params","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":26,"name":"P","package":"@boost/cli","refersToTypeParameter":true}},{"id":30,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":25,"name":"O","package":"@boost/cli","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/cli-test/function/runCommand","previousId":19,"nextId":43},{"id":43,"name":"runProgram","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":261,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L261"}],"signatures":[{"id":44,"name":"runProgram","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Runs a "},{"kind":"code","text":"`Program`"},{"kind":"text","text":" as if it were ran on the command line, including middleware,\\ncommands, success and failure states, and more. Utilizes mocked streams to capture\\nand return standard output and ANSI stripped output. Failed runs will not throw\\nand instead will render a failure output.\\n\\n"},{"kind":"code","text":"```ts\\nimport { runProgram } from \'@boost/cli/test\';\\nimport Program from \'../src/program\';\\n\\nit(\'runs a program\', async () => {\\n\\tconst program = new Program();\\n\\n\\tconst { code, output } = await runProgram(program, [\'cmd\', \'--foo\', \'123\', \'bar\']);\\n\\n\\texpect(output).toMatchSnapshot();\\n\\texpect(code).toBe(0);\\n});\\n```"}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":261,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L261"}],"parameters":[{"id":45,"name":"program","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2033,"name":"Program","package":"@boost/cli"}},{"id":46,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":47,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":48,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":49,"name":"append","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/test.ts","line":264,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L264"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[49]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":264,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L264"}]}},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reflection","declaration":{"id":50,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":51,"name":"code","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":265,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L265"}],"type":{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"}},{"id":52,"name":"output","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":265,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L265"}],"type":{"type":"intrinsic","name":"string"}},{"id":53,"name":"outputStripped","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":265,"character":45,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L265"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[51,52,53]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":265,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L265"}]}}],"name":"Promise","package":"typescript"}}],"permalink":"/api/cli-test/function/runProgram","previousId":23,"nextId":31},{"id":31,"name":"runTask","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":208,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L208"}],"signatures":[{"id":32,"name":"runTask","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Runs a task function outside the context of a "},{"kind":"code","text":"`Command`"},{"kind":"text","text":", in complete isolation.\\nA mock command context is provided with standard defaults, and can be customized\\nthrough the 3rd argument.\\n\\n"},{"kind":"code","text":"```ts\\nimport { runTask } from \'@boost/cli/test\';\\nimport testTask from \'../src/tasks/testTask\';\\n\\nit(\'runs a task\', async () => {\\n\\tconst context = {\\n\\t\\tlog: vi.fn(),\\n\\t};\\n\\n\\texpect(await runTask(testTask, [\'foo\', \'bar\', \'baz\'], context)).toMatchSnapshot();\\n\\texpect(context.log).toHaveBeenCalled();\\n});\\n```"}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":208,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L208"}],"typeParameter":[{"id":33,"name":"A","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":34,"name":"R","variant":"typeParam","kind":131072,"flags":{}},{"id":35,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2367,"name":"TaskContext","package":"@boost/cli"}}],"parameters":[{"id":36,"name":"task","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":37,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":209,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L209"}],"signatures":[{"id":38,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":209,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L209"}],"parameters":[{"id":39,"name":"this","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":35,"name":"T","package":"@boost/cli","refersToTypeParameter":true}},{"id":40,"name":"argz","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":33,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":34,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}}},{"id":41,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":33,"name":"A","package":"@boost/cli","refersToTypeParameter":true}},{"id":42,"name":"context","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":35,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":34,"name":"R","package":"@boost/cli","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}],"permalink":"/api/cli-test/function/runTask","previousId":43}],"groups":[{"title":"Classes","children":[54,58]},{"title":"Functions","children":[15,12,19,23,43,31]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L1"}],"permalink":"/api/cli-test"},"urlSlug":"cli-test"}],"packageName":"@boost/cli","packageVersion":"5.0.0-alpha.3"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":74,"name":"@boost/common","variant":"declaration","kind":2,"flags":{},"children":[{"id":2610,"name":"json","variant":"declaration","kind":4,"flags":{},"children":[{"id":2629,"name":"JSONStringifyOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2631,"name":"quote","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L9"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"}]}},{"id":2632,"name":"replacer","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L10"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}},{"type":"reflection","declaration":{"id":2633,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":10,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L10"}],"signatures":[{"id":2634,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":10,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L10"}],"parameters":[{"id":2635,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2636,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"unknown"}}]}}]}},{"id":2630,"name":"space","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L8"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","children":[2631,2632,2630]}],"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L7"}],"permalink":"/api/common/namespace/json#JSONStringifyOptions"},{"id":2624,"name":"JSONReviver","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L5"}],"type":{"type":"reflection","declaration":{"id":2625,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":5,"character":26,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L5"}],"signatures":[{"id":2626,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2627,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2628,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"unknown"}}]}},"permalink":"/api/common/namespace/json#JSONReviver"},{"id":2620,"name":"load","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L21"}],"signatures":[{"id":2621,"name":"load","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L21"}],"typeParameter":[{"id":2622,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2623,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2622,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/namespace/json#load"},{"id":2611,"name":"parse","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L13"}],"signatures":[{"id":2612,"name":"parse","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L13"}],"typeParameter":[{"id":2613,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2614,"name":"content","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2615,"name":"reviver","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2624,"name":"JSONReviver","package":"@boost/common"}}],"type":{"type":"reference","target":2613,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/namespace/json#parse"},{"id":2616,"name":"stringify","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L17"}],"signatures":[{"id":2617,"name":"stringify","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L17"}],"parameters":[{"id":2618,"name":"content","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":2619,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2629,"name":"JSONStringifyOptions","package":"@boost/common"},"defaultValue":"{}"}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/common/namespace/json#stringify"}],"groups":[{"title":"Interfaces","children":[2629]},{"title":"Type Aliases","children":[2624]},{"title":"Functions","children":[2620,2611,2616]}],"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L1"}],"permalink":"/api/common/namespace/json","previousId":3051,"nextId":2637},{"id":2637,"name":"yaml","variant":"declaration","kind":4,"flags":{},"children":[{"id":2647,"name":"load","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":27,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L27"}],"signatures":[{"id":2648,"name":"load","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":27,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L27"}],"typeParameter":[{"id":2649,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2650,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2649,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/namespace/yaml#load"},{"id":2638,"name":"parse","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L13"}],"signatures":[{"id":2639,"name":"parse","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L13"}],"typeParameter":[{"id":2640,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2641,"name":"content","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2642,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"DocumentOptions"},"name":"DocumentOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"ParseOptions"},"name":"ParseOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"SchemaOptions"},"name":"SchemaOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"ToJSOptions"},"name":"ToJSOptions","package":"yaml"}]}}],"type":{"type":"reference","target":2640,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/namespace/yaml#parse"},{"id":2643,"name":"stringify","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L20"}],"signatures":[{"id":2644,"name":"stringify","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L20"}],"parameters":[{"id":2645,"name":"content","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":2646,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"CreateNodeOptions"},"name":"CreateNodeOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"DocumentOptions"},"name":"DocumentOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"ParseOptions"},"name":"ParseOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"SchemaOptions"},"name":"SchemaOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"ToStringOptions"},"name":"ToStringOptions","package":"yaml"}]}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/common/namespace/yaml#stringify"}],"groups":[{"title":"Functions","children":[2647,2638,2643]}],"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L1"}],"permalink":"/api/common/namespace/yaml","previousId":2610,"nextId":2937},{"id":2659,"name":"Contract","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":2660,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L8"}],"signatures":[{"id":2661,"name":"new Contract","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L8"}],"typeParameter":[{"id":2662,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":2663,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":2664,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2659,"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}}]},{"id":2665,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/src/Contract.ts","line":6,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L6"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"implementationOf":{"type":"reference","target":2956,"name":"Optionable.options"}},{"id":2672,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting."}]},"sources":[{"fileName":"packages/common/src/Contract.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L51"}],"signatures":[{"id":2673,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/src/Contract.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L51"}],"parameters":[{"id":2674,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":2675,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"implementationOf":{"type":"reference","target":-1,"name":"Optionable.blueprint"}}],"implementationOf":{"type":"reference","target":2957,"name":"Optionable.blueprint"}},{"id":2666,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L28"}],"signatures":[{"id":2667,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/src/Contract.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L28"}],"parameters":[{"id":2668,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":2669,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":28,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L28"}],"signatures":[{"id":2670,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":28,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L28"}],"parameters":[{"id":2671,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[2660]},{"title":"Properties","children":[2665]},{"title":"Methods","children":[2672,2666]}],"sources":[{"fileName":"packages/common/src/Contract.ts","line":4,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L4"}],"typeParameters":[{"id":2676,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":2677,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":4,"character":50,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L4"}]}}}],"implementedTypes":[{"type":"reference","target":2955,"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Optionable","package":"@boost/common"}],"permalink":"/api/common/class/Contract","nextId":2678},{"id":2678,"name":"ExitError","variant":"declaration","kind":128,"flags":{},"children":[{"id":2679,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/ExitError.ts","line":4,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ExitError.ts#L4"}],"signatures":[{"id":2680,"name":"new ExitError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/ExitError.ts","line":4,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ExitError.ts#L4"}],"parameters":[{"id":2681,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2682,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":2678,"name":"ExitError","package":"@boost/common"},"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}},{"id":2683,"name":"code","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/ExitError.ts","line":2,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ExitError.ts#L2"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","children":[2679]},{"title":"Properties","children":[2683]}],"sources":[{"fileName":"packages/common/src/ExitError.ts","line":1,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ExitError.ts#L1"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}],"permalink":"/api/common/class/ExitError","previousId":2659,"nextId":2735},{"id":2735,"name":"ModulePath","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"An immutable class for operating on Node.js module IDs, names, and paths."}]},"children":[{"id":2742,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L12"}],"signatures":[{"id":2743,"name":"new ModulePath","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L12"}],"parameters":[{"id":2744,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2735,"name":"ModulePath","package":"@boost/common"}}]},{"id":2747,"name":"append","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L34"}],"signatures":[{"id":2748,"name":"append","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Append path parts to the end of the current path\\nand return a new "},{"kind":"code","text":"`ModulePath`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L34"}],"parameters":[{"id":2749,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2735,"name":"ModulePath","package":"@boost/common"}}]},{"id":2750,"name":"hasScope","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L43"}],"signatures":[{"id":2751,"name":"hasScope","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the module is scoped within a private namespace\\n(starts with @)."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L43"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2752,"name":"name","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L51"}],"signatures":[{"id":2753,"name":"name","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the module name without any trailing import paths,\\nor optionally without the private scope."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L51"}],"parameters":[{"id":2754,"name":"withoutScope","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2755,"name":"path","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":64,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L64"}],"signatures":[{"id":2756,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the current module path as a normalized string."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":64,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L64"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2914,"name":"Pathable.path"}}],"implementationOf":{"type":"reference","target":2914,"name":"Pathable.path"}},{"id":2757,"name":"scope","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":79,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L79"}],"signatures":[{"id":2758,"name":"scope","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the private scope with leading @, or null if not defined."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":79,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L79"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"}]}}]},{"id":2759,"name":"toJSON","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":87,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L87"}],"signatures":[{"id":2760,"name":"toJSON","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":87,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L87"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2761,"name":"toString","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L91"}],"signatures":[{"id":2762,"name":"toString","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L91"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2917,"name":"Pathable.toString"}}],"implementationOf":{"type":"reference","target":2917,"name":"Pathable.toString"}},{"id":2736,"name":"create","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":19,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L19"}],"signatures":[{"id":2737,"name":"create","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a new "},{"kind":"code","text":"`ModulePath`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":19,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L19"}],"parameters":[{"id":2738,"name":"id","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2735,"name":"ModulePath","package":"@boost/common"}}]},{"id":2739,"name":"path","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L26"}],"signatures":[{"id":2740,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a module path-like value to a formatted module path string."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L26"}],"parameters":[{"id":2741,"name":"part","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"string"}}]}],"groups":[{"title":"Constructors","children":[2742]},{"title":"Methods","children":[2747,2750,2752,2755,2757,2759,2761,2736,2739]}],"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L7"}],"implementedTypes":[{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}],"permalink":"/api/common/class/ModulePath","previousId":2678,"nextId":2763},{"id":2763,"name":"PackageGraph","variant":"declaration","kind":128,"flags":{},"children":[{"id":2764,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L24"}],"signatures":[{"id":2765,"name":"new PackageGraph","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L24"}],"typeParameter":[{"id":2766,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"},"default":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"parameters":[{"id":2767,"name":"packages","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}},"defaultValue":"[]"}],"type":{"type":"reference","target":2763,"typeArguments":[{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}],"name":"PackageGraph","package":"@boost/common"}}]},{"id":2771,"name":"addPackage","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L33"}],"signatures":[{"id":2772,"name":"addPackage","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a package by name with an associated "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" object.\\nWill map a dependency between the package and its dependees\\nfound in "},{"kind":"code","text":"`dependencies`"},{"kind":"text","text":" and "},{"kind":"code","text":"`peerDependencies`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L33"}],"parameters":[{"id":2773,"name":"pkg","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2774,"name":"addPackages","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L50"}],"signatures":[{"id":2775,"name":"addPackages","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add multiple packages."}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L50"}],"parameters":[{"id":2776,"name":"packages","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}},"defaultValue":"[]"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2781,"name":"resolveBatchList","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L153"}],"signatures":[{"id":2782,"name":"resolveBatchList","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the dependency graph and return a list of batched "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" objects\\n(array of arrays) in the order they are depended on.\\n\\n"},{"kind":"code","text":"```ts\\ngraph.resolveBatchList().forEach((pkgs) => {\\n\\tpkgs.forEach((pkg) => {\\n\\t\\tconsole.log(pkg.name);\\n\\t});\\n});\\n```"}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L153"}],"type":{"type":"array","elementType":{"type":"array","elementType":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}}}}]},{"id":2777,"name":"resolveList","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":68,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L68"}],"signatures":[{"id":2778,"name":"resolveList","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the dependency graph and return a list of all\\n"},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" objects in the order they are depended on.\\n\\n"},{"kind":"code","text":"```ts\\ngraph.resolveList().forEach((pkg) => {\\n\\tconsole.log(pkg.name);\\n});\\n```"}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":68,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L68"}],"type":{"type":"array","elementType":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}}}]},{"id":2779,"name":"resolveTree","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L90"}],"signatures":[{"id":2780,"name":"resolveTree","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the dependency graph and return a tree of nodes for all\\n"},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" objects and their dependency mappings.\\n\\n"},{"kind":"code","text":"```ts\\ngraph.resolveTree().nodes.forEach((node) => {\\n\\tconsole.log(node.package.name);\\n\\n\\tif (node.nodes) {\\n\\t\\t// Dependents\\n\\t}\\n});\\n```"}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L90"}],"type":{"type":"reference","target":3041,"typeArguments":[{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}],"name":"PackageGraphTree","package":"@boost/common"}}]}],"groups":[{"title":"Constructors","children":[2764]},{"title":"Methods","children":[2771,2774,2781,2777,2779]}],"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":17,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L17"}],"typeParameters":[{"id":2801,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"},"default":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"permalink":"/api/common/class/PackageGraph","previousId":2735,"nextId":2802},{"id":2802,"name":"Path","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"An immutable class for operating on file system paths.\\nWill normalize path separators based on the operating system,\\n\\"/\\" on Linux/MacOS, and \\"\\\\\\\\\\" on Windows."}]},"children":[{"id":2815,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L19"}],"signatures":[{"id":2816,"name":"new Path","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L19"}],"parameters":[{"id":2817,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2803,"name":"DELIMITER","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":11,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L11"}],"type":{"type":"union","types":[{"type":"literal","value":";"},{"type":"literal","value":":"}]},"defaultValue":"path.delimiter"},{"id":2804,"name":"SEP","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":13,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L13"}],"type":{"type":"union","types":[{"type":"literal","value":"\\\\"},{"type":"literal","value":"/"}]},"defaultValue":"path.sep"},{"id":2820,"name":"append","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L48"}],"signatures":[{"id":2821,"name":"append","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Append path parts to the end of the current path\\nand return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L48"}],"parameters":[{"id":2822,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2823,"name":"equals","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L55"}],"signatures":[{"id":2824,"name":"equals","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns true if both paths are equal using strict equality."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L55"}],"parameters":[{"id":2825,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2829,"name":"exists","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":71,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L71"}],"signatures":[{"id":2830,"name":"exists","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path exists."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":71,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L71"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2826,"name":"ext","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":62,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L62"}],"signatures":[{"id":2827,"name":"ext","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the extension (if applicable) with or without leading period."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":62,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L62"}],"parameters":[{"id":2828,"name":"withoutPeriod","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2831,"name":"isAbsolute","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L78"}],"signatures":[{"id":2832,"name":"isAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is absolute."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L78"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2833,"name":"isDirectory","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L85"}],"signatures":[{"id":2834,"name":"isDirectory","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is a folder."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L85"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2835,"name":"isFile","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L92"}],"signatures":[{"id":2836,"name":"isFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is a file."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L92"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2837,"name":"name","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L99"}],"signatures":[{"id":2838,"name":"name","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the file name (with optional extension) or folder name."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L99"}],"parameters":[{"id":2839,"name":"withoutExtension","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2840,"name":"parent","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L112"}],"signatures":[{"id":2841,"name":"parent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the parent folder as a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L112"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2842,"name":"path","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L119"}],"signatures":[{"id":2843,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the current path as a normalized string."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L119"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2914,"name":"Pathable.path"}}],"implementationOf":{"type":"reference","target":2914,"name":"Pathable.path"}},{"id":2844,"name":"prepend","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L132"}],"signatures":[{"id":2845,"name":"prepend","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Prepend path parts to the beginning of the current path\\nand return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L132"}],"parameters":[{"id":2846,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2847,"name":"realPath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L140"}],"signatures":[{"id":2848,"name":"realPath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a canonical path by resolving directories and symlinks."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L140"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2849,"name":"relativeTo","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":148,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L148"}],"signatures":[{"id":2850,"name":"relativeTo","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a new relative "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance from the current\\n\\"from\\" path to the defined \\"to\\" path."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":148,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L148"}],"parameters":[{"id":2851,"name":"to","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2852,"name":"resolve","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L156"}],"signatures":[{"id":2853,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance where the current path is accurately\\nresolved against the defined working directory."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L156"}],"parameters":[{"id":2854,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2855,"name":"toJSON","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L160"}],"signatures":[{"id":2856,"name":"toJSON","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L160"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2857,"name":"toString","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L164"}],"signatures":[{"id":2858,"name":"toString","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L164"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2917,"name":"Pathable.toString"}}],"implementationOf":{"type":"reference","target":2917,"name":"Pathable.toString"}},{"id":2805,"name":"create","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L26"}],"signatures":[{"id":2806,"name":"create","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L26"}],"parameters":[{"id":2807,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2808,"name":"path","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":33,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L33"}],"signatures":[{"id":2809,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a path-like value to a formatted path string."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":33,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L33"}],"parameters":[{"id":2810,"name":"part","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2811,"name":"resolve","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":40,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L40"}],"signatures":[{"id":2812,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`create()`"},{"kind":"text","text":" but also resolves the path against a working directory."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":40,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L40"}],"parameters":[{"id":2813,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}},{"id":2814,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]}],"groups":[{"title":"Constructors","children":[2815]},{"title":"Properties","children":[2803,2804]},{"title":"Methods","children":[2820,2823,2829,2826,2831,2833,2835,2837,2840,2842,2844,2847,2849,2852,2855,2857,2805,2808,2811]}],"sources":[{"fileName":"packages/common/src/Path.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L10"}],"extendedBy":[{"type":"reference","target":3055,"name":"VirtualPath"}],"implementedTypes":[{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}],"permalink":"/api/common/class/Path","previousId":2763,"nextId":2859},{"id":2859,"name":"PathResolver","variant":"declaration","kind":128,"flags":{},"children":[{"id":2864,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L12"}],"signatures":[{"id":2865,"name":"new PathResolver","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L12"}],"parameters":[{"id":2866,"name":"resolver","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2922,"name":"ModuleResolver","package":"@boost/common"}}],"type":{"type":"reference","target":2859,"name":"PathResolver","package":"@boost/common"}}]},{"id":2869,"name":"getLookupPaths","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L38"}],"signatures":[{"id":2870,"name":"getLookupPaths","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all lookup paths."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L38"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}]},{"id":2871,"name":"lookupFilePath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":46,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L46"}],"signatures":[{"id":2872,"name":"lookupFilePath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a file system path to look for, resolved against the defined current\\nworking directory (or "},{"kind":"code","text":"`process.cwd()`"},{"kind":"text","text":" otherwise)."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":46,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L46"}],"parameters":[{"id":2873,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}},{"id":2874,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2875,"name":"lookupFilePathWithExts","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":60,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L60"}],"signatures":[{"id":2876,"name":"lookupFilePathWithExts","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a file system path with a list of possible extensions to look for,\\nresolved against the defined current working directory (or "},{"kind":"code","text":"`process.cwd()`"},{"kind":"text","text":" otherwise)."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":60,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L60"}],"parameters":[{"id":2877,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}},{"id":2878,"name":"exts","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2879,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2880,"name":"lookupNodeModule","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L73"}],"signatures":[{"id":2881,"name":"lookupNodeModule","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a Node.js module, either by name or relative path, to look for."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L73"}],"parameters":[{"id":2882,"name":"moduleId","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2883,"name":"resolve","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":88,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L88"}],"signatures":[{"id":2884,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Given a list of lookups, attempt to find the first real/existing path and\\nreturn a resolved absolute path. If a file system path, will check using "},{"kind":"code","text":"`fs.exists`"},{"kind":"text","text":".\\nIf a node module path, will check using the provided resolver."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":88,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L88"}],"parameters":[{"id":2885,"name":"startDir","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2933,"name":"ResolvedLookup","package":"@boost/common"}],"name":"Promise","package":"typescript"}}]},{"id":2886,"name":"resolvePath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":136,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L136"}],"signatures":[{"id":2887,"name":"resolvePath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`resolve()`"},{"kind":"text","text":" but only returns the resolved file path."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":136,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L136"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}],"name":"Promise","package":"typescript"}}]},{"id":2860,"name":"defaultResolver","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":16,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L16"}],"signatures":[{"id":2861,"name":"defaultResolver","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":16,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L16"}],"parameters":[{"id":2862,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2863,"name":"startDir","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[2864]},{"title":"Methods","children":[2869,2871,2875,2880,2883,2886,2860]}],"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L7"}],"permalink":"/api/common/class/PathResolver","previousId":2802,"nextId":2890},{"id":2890,"name":"Project","variant":"declaration","kind":128,"flags":{},"children":[{"id":2894,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L18"}],"signatures":[{"id":2895,"name":"new Project","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L18"}],"parameters":[{"id":2896,"name":"root","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"},"defaultValue":"..."}],"type":{"type":"reference","target":2890,"name":"Project","package":"@boost/common"}}]},{"id":2897,"name":"root","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/common/src/Project.ts","line":16,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L16"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}},{"id":2898,"name":"createWorkspaceMetadata","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L33"}],"signatures":[{"id":2899,"name":"createWorkspaceMetadata","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create a workspace metadata object composed of absolute file paths."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L33"}],"parameters":[{"id":2900,"name":"jsonPath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":3045,"name":"WorkspaceMetadata","package":"@boost/common"}}]},{"id":2901,"name":"getPackage","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L51"}],"signatures":[{"id":2902,"name":"getPackage","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the contents of the root "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L51"}],"typeParameter":[{"id":2903,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"type":{"type":"reference","target":2903,"name":"T","package":"@boost/common","refersToTypeParameter":true}}]},{"id":2904,"name":"getWorkspaceGlobs","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L67"}],"signatures":[{"id":2905,"name":"getWorkspaceGlobs","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all workspace globs as they are configured\\nin "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" or "},{"kind":"code","text":"`lerna.json`"},{"kind":"text","text":". Glob patterns will _always_\\nuse forward slashes, regardless of OS."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L67"}],"parameters":[{"id":2906,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2888,"name":"ProjectSearchOptions","package":"@boost/common"},"defaultValue":"{}"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}]},{"id":2910,"name":"getWorkspacePackagePaths","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L140"}],"signatures":[{"id":2911,"name":"getWorkspacePackagePaths","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all workspace package paths, resolved against the file system.\\nAbsolute file paths are returned unless the "},{"kind":"code","text":"`relative`"},{"kind":"text","text":" option is true."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L140"}],"parameters":[{"id":2912,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2888,"name":"ProjectSearchOptions","package":"@boost/common"},"defaultValue":"{}"}],"type":{"type":"array","elementType":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}}]},{"id":2907,"name":"getWorkspacePackages","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L118"}],"signatures":[{"id":2908,"name":"getWorkspacePackages","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return all "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":"s across all workspaces and their packages.\\nOnce loaded, append workspace path metadata."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L118"}],"typeParameter":[{"id":2909,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"type":{"type":"array","elementType":{"type":"reference","target":3051,"typeArguments":[{"type":"reference","target":2909,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"WorkspacePackage","package":"@boost/common"}}}]},{"id":2891,"name":"normalizeGlob","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Project.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L26"}],"signatures":[{"id":2892,"name":"normalizeGlob","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize a glob pattern or path for use on POSIX and Windows machines."}],"blockTags":[{"tag":"@link","content":[{"kind":"text","text":"https://github.com/mrmlnc/fast-glob#how-to-write-patterns-on-windows"}]}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L26"}],"parameters":[{"id":2893,"name":"pattern","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}]}],"groups":[{"title":"Constructors","children":[2894]},{"title":"Properties","children":[2897]},{"title":"Methods","children":[2898,2901,2904,2910,2907,2891]}],"sources":[{"fileName":"packages/common/src/Project.ts","line":15,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L15"}],"permalink":"/api/common/class/Project","previousId":2859,"nextId":3055},{"id":3055,"name":"VirtualPath","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"An immutable class for operating on file system paths,\\nthat always normalize using a forward slash (\\"/\\") for path separators.\\nUseful for paths found in configurations, globs, etc."}]},"children":[{"id":3068,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L19"}],"signatures":[{"id":3069,"name":"new VirtualPath","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L19"}],"parameters":[{"id":3070,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":3055,"name":"VirtualPath","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2816,"name":"Path.constructor"}}],"inheritedFrom":{"type":"reference","target":2815,"name":"Path.constructor"}},{"id":3059,"name":"DELIMITER","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":11,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L11"}],"type":{"type":"union","types":[{"type":"literal","value":";"},{"type":"literal","value":":"}]},"defaultValue":"path.delimiter","inheritedFrom":{"type":"reference","target":2803,"name":"Path.DELIMITER"}},{"id":3060,"name":"SEP","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":13,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L13"}],"type":{"type":"union","types":[{"type":"literal","value":"\\\\"},{"type":"literal","value":"/"}]},"defaultValue":"path.sep","inheritedFrom":{"type":"reference","target":2804,"name":"Path.SEP"}},{"id":3075,"name":"append","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L48"}],"signatures":[{"id":3076,"name":"append","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Append path parts to the end of the current path\\nand return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L48"}],"parameters":[{"id":3077,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2821,"name":"Path.append"}}],"inheritedFrom":{"type":"reference","target":2820,"name":"Path.append"}},{"id":3078,"name":"equals","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L55"}],"signatures":[{"id":3079,"name":"equals","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns true if both paths are equal using strict equality."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L55"}],"parameters":[{"id":3080,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2824,"name":"Path.equals"}}],"inheritedFrom":{"type":"reference","target":2823,"name":"Path.equals"}},{"id":3084,"name":"exists","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":71,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L71"}],"signatures":[{"id":3085,"name":"exists","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path exists."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":71,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L71"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2830,"name":"Path.exists"}}],"inheritedFrom":{"type":"reference","target":2829,"name":"Path.exists"}},{"id":3081,"name":"ext","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":62,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L62"}],"signatures":[{"id":3082,"name":"ext","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the extension (if applicable) with or without leading period."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":62,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L62"}],"parameters":[{"id":3083,"name":"withoutPeriod","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2827,"name":"Path.ext"}}],"inheritedFrom":{"type":"reference","target":2826,"name":"Path.ext"}},{"id":3086,"name":"isAbsolute","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L78"}],"signatures":[{"id":3087,"name":"isAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is absolute."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L78"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2832,"name":"Path.isAbsolute"}}],"inheritedFrom":{"type":"reference","target":2831,"name":"Path.isAbsolute"}},{"id":3088,"name":"isDirectory","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L85"}],"signatures":[{"id":3089,"name":"isDirectory","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is a folder."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L85"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2834,"name":"Path.isDirectory"}}],"inheritedFrom":{"type":"reference","target":2833,"name":"Path.isDirectory"}},{"id":3090,"name":"isFile","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L92"}],"signatures":[{"id":3091,"name":"isFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is a file."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L92"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2836,"name":"Path.isFile"}}],"inheritedFrom":{"type":"reference","target":2835,"name":"Path.isFile"}},{"id":3092,"name":"name","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L99"}],"signatures":[{"id":3093,"name":"name","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the file name (with optional extension) or folder name."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L99"}],"parameters":[{"id":3094,"name":"withoutExtension","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2838,"name":"Path.name"}}],"inheritedFrom":{"type":"reference","target":2837,"name":"Path.name"}},{"id":3095,"name":"parent","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L112"}],"signatures":[{"id":3096,"name":"parent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the parent folder as a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L112"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2841,"name":"Path.parent"}}],"inheritedFrom":{"type":"reference","target":2840,"name":"Path.parent"}},{"id":3071,"name":"path","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":22,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L22"}],"signatures":[{"id":3072,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the current module path as a normalized string,\\nconverting all path separators to \\"/\\"."}]},"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":22,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L22"}],"type":{"type":"intrinsic","name":"string"},"overwrites":{"type":"reference","target":2843,"name":"Path.path"}}],"overwrites":{"type":"reference","target":2842,"name":"Path.path"}},{"id":3097,"name":"prepend","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L132"}],"signatures":[{"id":3098,"name":"prepend","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Prepend path parts to the beginning of the current path\\nand return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L132"}],"parameters":[{"id":3099,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2845,"name":"Path.prepend"}}],"inheritedFrom":{"type":"reference","target":2844,"name":"Path.prepend"}},{"id":3100,"name":"realPath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L140"}],"signatures":[{"id":3101,"name":"realPath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a canonical path by resolving directories and symlinks."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L140"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2848,"name":"Path.realPath"}}],"inheritedFrom":{"type":"reference","target":2847,"name":"Path.realPath"}},{"id":3102,"name":"relativeTo","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":148,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L148"}],"signatures":[{"id":3103,"name":"relativeTo","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a new relative "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance from the current\\n\\"from\\" path to the defined \\"to\\" path."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":148,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L148"}],"parameters":[{"id":3104,"name":"to","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2850,"name":"Path.relativeTo"}}],"inheritedFrom":{"type":"reference","target":2849,"name":"Path.relativeTo"}},{"id":3105,"name":"resolve","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L156"}],"signatures":[{"id":3106,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance where the current path is accurately\\nresolved against the defined working directory."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L156"}],"parameters":[{"id":3107,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2853,"name":"Path.resolve"}}],"inheritedFrom":{"type":"reference","target":2852,"name":"Path.resolve"}},{"id":3108,"name":"toJSON","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L160"}],"signatures":[{"id":3109,"name":"toJSON","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L160"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2856,"name":"Path.toJSON"}}],"inheritedFrom":{"type":"reference","target":2855,"name":"Path.toJSON"}},{"id":3110,"name":"toString","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L164"}],"signatures":[{"id":3111,"name":"toString","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L164"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2858,"name":"Path.toString"}}],"inheritedFrom":{"type":"reference","target":2857,"name":"Path.toString"}},{"id":3061,"name":"create","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L26"}],"signatures":[{"id":3062,"name":"create","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L26"}],"parameters":[{"id":3063,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2806,"name":"Path.create"}}],"inheritedFrom":{"type":"reference","target":2805,"name":"Path.create"}},{"id":3056,"name":"path","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":14,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L14"}],"signatures":[{"id":3057,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a path-like value to a formatted virtual path string."}]},"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":14,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L14"}],"parameters":[{"id":3058,"name":"part","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"string"},"overwrites":{"type":"reference","target":2809,"name":"Path.path"}}],"overwrites":{"type":"reference","target":2808,"name":"Path.path"}},{"id":3064,"name":"resolve","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":40,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L40"}],"signatures":[{"id":3065,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`create()`"},{"kind":"text","text":" but also resolves the path against a working directory."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":40,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L40"}],"parameters":[{"id":3066,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}},{"id":3067,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2812,"name":"Path.resolve"}}],"inheritedFrom":{"type":"reference","target":2811,"name":"Path.resolve"}}],"groups":[{"title":"Constructors","children":[3068]},{"title":"Properties","children":[3059,3060]},{"title":"Methods","children":[3075,3078,3084,3081,3086,3088,3090,3092,3095,3071,3097,3100,3102,3105,3108,3110,3061,3056,3064]}],"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L10"}],"extendedTypes":[{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}],"permalink":"/api/common/class/VirtualPath","previousId":2890,"nextId":3112},{"id":2965,"name":"BugSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2967,"name":"email","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L78"}],"type":{"type":"intrinsic","name":"string"}},{"id":2966,"name":"url","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":77,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L77"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2967,2966]}],"sources":[{"fileName":"packages/common/src/types.ts","line":76,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L76"}],"permalink":"/api/common/interface/BugSetting","previousId":2731,"nextId":2969},{"id":2969,"name":"DependencyMetaSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2970,"name":"built","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L84"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2971,"name":"optional","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L85"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2972,"name":"unplugged","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":86,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L86"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2970,2971,2972]}],"sources":[{"fileName":"packages/common/src/types.ts","line":83,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L83"}],"permalink":"/api/common/interface/DependencyMetaSetting","previousId":2965,"nextId":2929},{"id":2929,"name":"Lookup","variant":"declaration","kind":256,"flags":{},"children":[{"id":2930,"name":"path","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L26"}],"type":{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}},{"id":2931,"name":"raw","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L27"}],"type":{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}},{"id":2932,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L28"}],"type":{"type":"reference","target":2928,"name":"LookupType","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[2930,2931,2932]}],"sources":[{"fileName":"packages/common/src/types.ts","line":25,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L25"}],"permalink":"/api/common/interface/Lookup","previousId":2969,"nextId":3143},{"id":3143,"name":"MemoizeOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3144,"name":"cache","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A custom "},{"kind":"code","text":"`Map`"},{"kind":"text","text":" instance to store cached values. Can also be used to pre-cache expected values."}]},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":9,"character":4}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":3138,"typeArguments":[{"type":"reference","target":3147,"name":"T","package":"@boost/decorators","qualifiedName":"MemoizeOptions.T","refersToTypeParameter":true}],"name":"MemoizeCache","package":"@boost/decorators"}]}},{"id":3145,"name":"expires","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Time in milliseconds in which to keep the cache alive (TTL).\\nPass "},{"kind":"code","text":"`0`"},{"kind":"text","text":" to cache indefinitely. Defaults to "},{"kind":"code","text":"`0`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":14,"character":4}],"type":{"type":"intrinsic","name":"number"}},{"id":3146,"name":"hasher","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A hashing function to determine the cache key. Is passed the method\'s arguments\\nand must return a string. If not provided, arguments are hashed using "},{"kind":"code","text":"`JSON.stringify()`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":19,"character":4}],"type":{"type":"reference","target":3134,"name":"MemoizeHasher","package":"@boost/decorators"}}],"groups":[{"title":"Properties","children":[3144,3145,3146]}],"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":7,"character":17}],"typeParameters":[{"id":3147,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/common/interface/MemoizeOptions","previousId":2929,"nextId":2955},{"id":2955,"name":"Optionable","variant":"declaration","kind":256,"flags":{},"children":[{"id":2957,"name":"blueprint","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":63,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L63"}],"type":{"type":"reference","target":2949,"typeArguments":[{"type":"intrinsic","name":"object"}],"name":"BlueprintFactory","package":"@boost/common"}},{"id":2956,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":57,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L57"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2958,"name":"T","package":"@boost/common","qualifiedName":"Optionable.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"}}],"groups":[{"title":"Properties","children":[2957,2956]}],"sources":[{"fileName":"packages/common/src/types.ts","line":55,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L55"}],"typeParameters":[{"id":2958,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":2959,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":55,"character":47,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L55"}]}}}],"implementedBy":[{"type":"reference","target":2659,"name":"Contract"}],"permalink":"/api/common/interface/Optionable","previousId":3143,"nextId":3041},{"id":3041,"name":"PackageGraphTree","variant":"declaration","kind":256,"flags":{},"children":[{"id":3042,"name":"nodes","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":176,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L176"}],"type":{"type":"array","elementType":{"type":"reference","target":3037,"typeArguments":[{"type":"reference","target":3044,"name":"T","package":"@boost/common","qualifiedName":"PackageGraphTree.T","refersToTypeParameter":true}],"name":"PackageGraphTreeNode","package":"@boost/common"}}},{"id":3043,"name":"root","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":177,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L177"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[3042,3043]}],"sources":[{"fileName":"packages/common/src/types.ts","line":175,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L175"}],"typeParameters":[{"id":3044,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"permalink":"/api/common/interface/PackageGraphTree","previousId":2955,"nextId":3037},{"id":3037,"name":"PackageGraphTreeNode","variant":"declaration","kind":256,"flags":{},"children":[{"id":3038,"name":"nodes","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L171"}],"type":{"type":"array","elementType":{"type":"reference","target":3037,"typeArguments":[{"type":"reference","target":3040,"name":"T","package":"@boost/common","qualifiedName":"PackageGraphTreeNode.T","refersToTypeParameter":true}],"name":"PackageGraphTreeNode","package":"@boost/common"}}},{"id":3039,"name":"package","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":172,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L172"}],"type":{"type":"reference","target":3040,"name":"T","package":"@boost/common","qualifiedName":"PackageGraphTreeNode.T","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[3038,3039]}],"sources":[{"fileName":"packages/common/src/types.ts","line":170,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L170"}],"typeParameters":[{"id":3040,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"permalink":"/api/common/interface/PackageGraphTreeNode","previousId":3041,"nextId":2986},{"id":2986,"name":"PackageStructure","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shape of "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":", with support for third-party properties\\nlike Yarn, Webpack, and TypeScript."}]},"children":[{"id":2987,"name":"author","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":113,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L113"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2978,"name":"PeopleSetting","package":"@boost/common"}]}},{"id":2988,"name":"bin","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":114,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L114"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}]}},{"id":2989,"name":"browser","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":115,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L115"}],"type":{"type":"intrinsic","name":"string"}},{"id":2990,"name":"browserslist","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":116,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L116"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2991,"name":"bugs","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L117"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2965,"name":"BugSetting","package":"@boost/common"}]}},{"id":2992,"name":"bundledDependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L118"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2993,"name":"config","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L119"}],"type":{"type":"reference","target":2964,"name":"ConfigSetting","package":"@boost/common"}},{"id":2994,"name":"contributors","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":120,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L120"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"array","elementType":{"type":"reference","target":2978,"name":"PeopleSetting","package":"@boost/common"}}]}},{"id":2995,"name":"cpu","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L121"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2996,"name":"dependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":122,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L122"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":2997,"name":"dependenciesMeta","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L123"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2969,"name":"DependencyMetaSetting","package":"@boost/common"}],"name":"Record","package":"typescript"}},{"id":2998,"name":"description","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":124,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L124"}],"type":{"type":"intrinsic","name":"string"}},{"id":2999,"name":"devDependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L125"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":3000,"name":"directories","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L126"}],"type":{"type":"reference","target":2962,"typeArguments":[{"type":"union","types":[{"type":"literal","value":"test"},{"type":"literal","value":"bin"},{"type":"literal","value":"doc"},{"type":"literal","value":"example"},{"type":"literal","value":"lib"},{"type":"literal","value":"man"}]}],"name":"SettingMap","package":"@boost/common"}},{"id":3001,"name":"engines","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L127"}],"type":{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}},{"id":3002,"name":"exports","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L128"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}]}],"name":"Record","package":"typescript"}]}},{"id":3003,"name":"files","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":129,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L129"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":3004,"name":"funding","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L130"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"},{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"}]}}]}},{"id":3005,"name":"homepage","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":131,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L131"}],"type":{"type":"intrinsic","name":"string"}},{"id":3006,"name":"imports","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L132"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}],"name":"Record","package":"typescript"}},{"id":3027,"name":"installConfig","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L156"}],"type":{"type":"reflection","declaration":{"id":3028,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3029,"name":"hoistingLimits","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":157,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L157"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[3029]}],"sources":[{"fileName":"packages/common/src/types.ts","line":156,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L156"}]}}},{"id":3007,"name":"keywords","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":133,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L133"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":3030,"name":"languageName","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":159,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L159"}],"type":{"type":"intrinsic","name":"string"}},{"id":3008,"name":"license","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":134,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L134"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"},{"type":"array","elementType":{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"}}]}},{"id":3009,"name":"main","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":135,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L135"}],"type":{"type":"intrinsic","name":"string"}},{"id":3010,"name":"man","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":136,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L136"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":3025,"name":"module","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L153"}],"type":{"type":"intrinsic","name":"string"}},{"id":3011,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":137,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L137"}],"type":{"type":"intrinsic","name":"string"}},{"id":3012,"name":"optionalDependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":138,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L138"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":3013,"name":"os","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":139,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L139"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":3014,"name":"peerDependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L140"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":3015,"name":"peerDependenciesMeta","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":141,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L141"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2976,"name":"PeerDependencyMetaSetting","package":"@boost/common"}],"name":"Record","package":"typescript"}},{"id":3031,"name":"preferUnplugged","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L160"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":3016,"name":"private","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":142,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L142"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":3017,"name":"publishConfig","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":143,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L143"}],"type":{"type":"reference","target":2964,"name":"ConfigSetting","package":"@boost/common"}},{"id":3018,"name":"repository","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":144,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L144"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2982,"name":"RepositorySetting","package":"@boost/common"}]}},{"id":3032,"name":"resolutions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":161,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L161"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":3019,"name":"scripts","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":145,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L145"}],"type":{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}},{"id":3026,"name":"sideEffects","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":154,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L154"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":3020,"name":"type","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":146,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L146"}],"type":{"type":"union","types":[{"type":"literal","value":"commonjs"},{"type":"literal","value":"module"}]}},{"id":3022,"name":"types","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":149,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L149"}],"type":{"type":"intrinsic","name":"string"}},{"id":3023,"name":"typesVersions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":150,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L150"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"Record","package":"typescript"}],"name":"Record","package":"typescript"}},{"id":3024,"name":"typings","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":151,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L151"}],"type":{"type":"intrinsic","name":"string"}},{"id":3021,"name":"version","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":147,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L147"}],"type":{"type":"intrinsic","name":"string"}},{"id":3033,"name":"workspaces","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L162"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"reflection","declaration":{"id":3034,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3036,"name":"nohoist","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":166,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L166"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":3035,"name":"packages","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":165,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L165"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","children":[3036,3035]}],"sources":[{"fileName":"packages/common/src/types.ts","line":164,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L164"}]}}]}}],"groups":[{"title":"Properties","children":[2987,2988,2989,2990,2991,2992,2993,2994,2995,2996,2997,2998,2999,3000,3001,3002,3003,3004,3005,3006,3027,3007,3030,3008,3009,3010,3025,3011,3012,3013,3014,3015,3031,3016,3017,3018,3032,3019,3026,3020,3022,3023,3024,3021,3033]}],"sources":[{"fileName":"packages/common/src/types.ts","line":112,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L112"}],"permalink":"/api/common/interface/PackageStructure","previousId":3037,"nextId":2913},{"id":2913,"name":"Pathable","variant":"declaration","kind":256,"flags":{},"children":[{"id":2914,"name":"path","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L7"}],"type":{"type":"reflection","declaration":{"id":2915,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":7,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L7"}],"signatures":[{"id":2916,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":7,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L7"}],"type":{"type":"intrinsic","name":"string"}}]}}},{"id":2917,"name":"toString","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L8"}],"type":{"type":"reflection","declaration":{"id":2918,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":8,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L8"}],"signatures":[{"id":2919,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":8,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L8"}],"type":{"type":"intrinsic","name":"string"}}]}}}],"groups":[{"title":"Properties","children":[2914,2917]}],"sources":[{"fileName":"packages/common/src/types.ts","line":6,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L6"}],"implementedBy":[{"type":"reference","target":2735,"name":"ModulePath"},{"type":"reference","target":2802,"name":"Path"}],"permalink":"/api/common/interface/Pathable","previousId":2986,"nextId":2976},{"id":2976,"name":"PeerDependencyMetaSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2977,"name":"optional","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2977]}],"sources":[{"fileName":"packages/common/src/types.ts","line":94,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L94"}],"permalink":"/api/common/interface/PeerDependencyMetaSetting","previousId":2913,"nextId":2978},{"id":2978,"name":"PeopleSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2980,"name":"email","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":100,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L100"}],"type":{"type":"intrinsic","name":"string"}},{"id":2979,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L99"}],"type":{"type":"intrinsic","name":"string"}},{"id":2981,"name":"url","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":101,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L101"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2980,2979,2981]}],"sources":[{"fileName":"packages/common/src/types.ts","line":98,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L98"}],"permalink":"/api/common/interface/PeopleSetting","previousId":2976,"nextId":2888},{"id":2888,"name":"ProjectSearchOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2889,"name":"relative","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/Project.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L12"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2889]}],"sources":[{"fileName":"packages/common/src/Project.ts","line":11,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L11"}],"permalink":"/api/common/interface/ProjectSearchOptions","previousId":2978,"nextId":2982},{"id":2982,"name":"RepositorySetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2983,"name":"directory","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L105"}],"type":{"type":"intrinsic","name":"string"}},{"id":2984,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L90"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2974,"name":"TypeSetting.type"}},{"id":2985,"name":"url","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L91"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2975,"name":"TypeSetting.url"}}],"groups":[{"title":"Properties","children":[2983,2984,2985]}],"sources":[{"fileName":"packages/common/src/types.ts","line":104,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L104"}],"extendedTypes":[{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"}],"permalink":"/api/common/interface/RepositorySetting","previousId":2888,"nextId":2933},{"id":2933,"name":"ResolvedLookup","variant":"declaration","kind":256,"flags":{},"children":[{"id":2934,"name":"originalSource","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Original file path or module ID of the lookup."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L33"}],"type":{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}},{"id":2935,"name":"resolvedPath","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolved absolute *file* path for the found lookup."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L35"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}},{"id":2936,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The type of lookup that was found."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":37,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L37"}],"type":{"type":"reference","target":2928,"name":"LookupType","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[2934,2935,2936]}],"sources":[{"fileName":"packages/common/src/types.ts","line":31,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L31"}],"permalink":"/api/common/interface/ResolvedLookup","previousId":2982,"nextId":2960},{"id":2960,"name":"Toolable","variant":"declaration","kind":256,"flags":{},"children":[{"id":2961,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L67"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2961]}],"sources":[{"fileName":"packages/common/src/types.ts","line":66,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L66"}],"permalink":"/api/common/interface/Toolable","previousId":2933,"nextId":2973},{"id":2973,"name":"TypeSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2974,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L90"}],"type":{"type":"intrinsic","name":"string"}},{"id":2975,"name":"url","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L91"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2974,2975]}],"sources":[{"fileName":"packages/common/src/types.ts","line":89,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L89"}],"extendedBy":[{"type":"reference","target":2982,"name":"RepositorySetting"}],"permalink":"/api/common/interface/TypeSetting","previousId":2960,"nextId":3045},{"id":3045,"name":"WorkspaceMetadata","variant":"declaration","kind":256,"flags":{},"children":[{"id":3046,"name":"jsonPath","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":183,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L183"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}},{"id":3048,"name":"packageName","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":185,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L185"}],"type":{"type":"intrinsic","name":"string"}},{"id":3047,"name":"packagePath","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":184,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L184"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}},{"id":3050,"name":"workspaceName","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":187,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L187"}],"type":{"type":"intrinsic","name":"string"}},{"id":3049,"name":"workspacePath","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":186,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L186"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[3046,3048,3047,3050,3049]}],"sources":[{"fileName":"packages/common/src/types.ts","line":182,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L182"}],"permalink":"/api/common/interface/WorkspaceMetadata","previousId":2973,"nextId":3051},{"id":3051,"name":"WorkspacePackage","variant":"declaration","kind":256,"flags":{},"children":[{"id":3052,"name":"metadata","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":191,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L191"}],"type":{"type":"reference","target":3045,"name":"WorkspaceMetadata","package":"@boost/common"}},{"id":3053,"name":"package","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":192,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L192"}],"type":{"type":"reference","target":3054,"name":"T","package":"@boost/common","qualifiedName":"WorkspacePackage.T","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[3052,3053]}],"sources":[{"fileName":"packages/common/src/types.ts","line":190,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L190"}],"typeParameters":[{"id":3054,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"},"default":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"permalink":"/api/common/interface/WorkspacePackage","previousId":3045,"nextId":2610},{"id":2937,"name":"AbstractConstructor","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":42,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L42"}],"typeParameters":[{"id":2941,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":2938,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":42,"character":37,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L42"}],"signatures":[{"id":2939,"name":"__type","variant":"signature","kind":16384,"flags":{"isAbstract":true},"parameters":[{"id":2940,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","target":2941,"name":"T","package":"@boost/common","refersToTypeParameter":true}}]}},"permalink":"/api/common#AbstractConstructor","previousId":2637,"nextId":2949},{"id":2949,"name":"BlueprintFactory","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":50,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L50"}],"typeParameters":[{"id":2954,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"type":{"type":"reflection","declaration":{"id":2950,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":50,"character":49,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L50"}],"signatures":[{"id":2951,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2952,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/index.d.ts","qualifiedName":"Schemas"},"name":"Schemas","package":"optimal"}},{"id":2953,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":2954,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"Blueprint","package":"optimal"}}]}},"permalink":"/api/common#BlueprintFactory","previousId":2937,"nextId":2651},{"id":2651,"name":"CommonErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/CommonError.ts","line":10,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/CommonError.ts#L10"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/common/src/CommonError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/common","preferValues":true}}},"permalink":"/api/common#CommonErrorCode","previousId":2949,"nextId":2942},{"id":2942,"name":"ConcreteConstructor","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":44,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L44"}],"typeParameters":[{"id":2946,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":2943,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":44,"character":37,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L44"}],"signatures":[{"id":2944,"name":"__type","variant":"signature","kind":16384,"flags":{},"parameters":[{"id":2945,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","target":2946,"name":"T","package":"@boost/common","refersToTypeParameter":true}}]}},"permalink":"/api/common#ConcreteConstructor","previousId":2651,"nextId":2964},{"id":2964,"name":"ConfigSetting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":74,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L74"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"name":"Record","package":"typescript"},"permalink":"/api/common#ConfigSetting","previousId":2942,"nextId":2947},{"id":2947,"name":"Constructor","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":46,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L46"}],"typeParameters":[{"id":2948,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"union","types":[{"type":"reference","target":2937,"typeArguments":[{"type":"reference","target":2948,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"AbstractConstructor","package":"@boost/common"},{"type":"reference","target":2942,"typeArguments":[{"type":"reference","target":2948,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"ConcreteConstructor","package":"@boost/common"}]},"permalink":"/api/common#Constructor","previousId":2964,"nextId":2968},{"id":2968,"name":"DependencyMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":81,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L81"}],"type":{"type":"reference","target":2962,"name":"SettingMap","package":"@boost/common"},"permalink":"/api/common#DependencyMap","previousId":2947,"nextId":2927},{"id":2927,"name":"FilePath","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":21,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L21"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/common#FilePath","previousId":2968,"nextId":2701},{"id":2701,"name":"InferMergeable","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":6,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L6"}],"typeParameters":[{"id":2702,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":2702,"name":"T","package":"@boost/common","refersToTypeParameter":true},"extendsType":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},"trueType":{"type":"reference","target":2698,"name":"MergableArray","package":"@boost/common"},"falseType":{"type":"conditional","checkType":{"type":"reference","target":2702,"name":"T","package":"@boost/common","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"object"},"trueType":{"type":"reference","target":2699,"name":"MergableObject","package":"@boost/common"},"falseType":{"type":"intrinsic","name":"never"}}},"permalink":"/api/common#InferMergeable","previousId":2927,"nextId":2928},{"id":2928,"name":"LookupType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":23,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L23"}],"type":{"type":"union","types":[{"type":"literal","value":"file-system"},{"type":"literal","value":"node-module"}]},"permalink":"/api/common#LookupType","previousId":2701,"nextId":3138},{"id":3138,"name":"MemoizeCache","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":3,"character":12}],"typeParameters":[{"id":3142,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reflection","declaration":{"id":3139,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3140,"name":"time","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":4,"character":4}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"literal","value":null}]}},{"id":3141,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":5,"character":4}],"type":{"type":"reference","target":3142,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[3140,3141]}],"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":3,"character":42}]}}],"name":"Map","package":"typescript"},"permalink":"/api/common#MemoizeCache","previousId":2928,"nextId":3134},{"id":3134,"name":"MemoizeHasher","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":2,"character":12}],"type":{"type":"reflection","declaration":{"id":3135,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":2,"character":28}],"signatures":[{"id":3136,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":3137,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"string"}}]}},"permalink":"/api/common#MemoizeHasher","previousId":3138,"nextId":3129},{"id":3129,"name":"MemoizedFunction","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":1,"character":12}],"typeParameters":[{"id":3133,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":3130,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":1,"character":34}],"signatures":[{"id":3131,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":3132,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"reference","target":3133,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}}]}},"permalink":"/api/common#MemoizedFunction","previousId":3134,"nextId":2698},{"id":2698,"name":"MergableArray","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L3"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},"permalink":"/api/common#MergableArray","previousId":3129,"nextId":2699},{"id":2699,"name":"MergableObject","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":4,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L4"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript"},"permalink":"/api/common#MergableObject","previousId":2698,"nextId":2700},{"id":2700,"name":"Mergeable","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L5"}],"type":{"type":"union","types":[{"type":"reference","target":2698,"name":"MergableArray","package":"@boost/common"},{"type":"reference","target":2699,"name":"MergableObject","package":"@boost/common"}]},"permalink":"/api/common#Mergeable","previousId":2699,"nextId":2921},{"id":2921,"name":"ModuleID","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/common#ModuleID","previousId":2700,"nextId":2922},{"id":2922,"name":"ModuleResolver","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":17,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L17"}],"type":{"type":"reflection","declaration":{"id":2923,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":17,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L17"}],"signatures":[{"id":2924,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2925,"name":"id","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2921,"name":"ModuleID","package":"@boost/common"}},{"id":2926,"name":"startDir","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2927,"name":"FilePath","package":"@boost/common"}}],"type":{"type":"union","types":[{"type":"reference","target":2927,"name":"FilePath","package":"@boost/common"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2927,"name":"FilePath","package":"@boost/common"}],"name":"Promise","package":"typescript"}]}}]}},"permalink":"/api/common#ModuleResolver","previousId":2921,"nextId":2920},{"id":2920,"name":"PortablePath","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L11"}],"type":{"type":"union","types":[{"type":"reference","target":2927,"name":"FilePath","package":"@boost/common"},{"type":"reference","target":2921,"name":"ModuleID","package":"@boost/common"},{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}]},"permalink":"/api/common#PortablePath","previousId":2922,"nextId":2962},{"id":2962,"name":"SettingMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":72,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L72"}],"typeParameters":[{"id":2963,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"reference","target":2963,"name":"T","package":"@boost/common","refersToTypeParameter":true},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript"},"permalink":"/api/common#SettingMap","previousId":2920,"nextId":2652},{"id":2652,"name":"CommonError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/common/src/CommonError.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/CommonError.ts#L12"}],"type":{"type":"reflection","declaration":{"id":2653,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":2654,"name":"new CommonError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":2655,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"PARSE_INVALID_EXT"},{"type":"literal","value":"PATH_REQUIRE_ABSOLUTE"},{"type":"literal","value":"PATH_RESOLVE_LOOKUPS"},{"type":"literal","value":"PROJECT_NO_PACKAGE"}]}},{"id":2656,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"PARSE_INVALID_EXT"},{"type":"literal","value":"PATH_REQUIRE_ABSOLUTE"},{"type":"literal","value":"PATH_RESOLVE_LOOKUPS"},{"type":"literal","value":"PROJECT_NO_PACKAGE"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/common#CommonError","previousId":2962,"nextId":2657},{"id":2657,"name":"MODULE_NAME_PART","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/common/src/constants.ts","line":2,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/constants.ts#L2"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/common#MODULE_NAME_PART","previousId":2652,"nextId":2658},{"id":2658,"name":"MODULE_NAME_PATTERN","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/common/src/constants.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/constants.ts#L4"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/common#MODULE_NAME_PATTERN","previousId":2657},{"id":3112,"name":"Bind","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Bind.d.ts","line":5,"character":24}],"signatures":[{"id":3113,"name":"Bind","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that automatically binds a class method\'s\\n"},{"kind":"code","text":"`this`"},{"kind":"text","text":" context to its current instance."}]},"sources":[{"fileName":"packages/decorators/mjs/Bind.d.ts","line":5,"character":24}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/common/function/Bind","previousId":3055,"nextId":3114},{"id":3114,"name":"Debounce","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Debounce.d.ts","line":5,"character":24}],"signatures":[{"id":3115,"name":"Debounce","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that delays the execution of the class method\\nby the provided time in milliseconds."}]},"sources":[{"fileName":"packages/decorators/mjs/Debounce.d.ts","line":5,"character":24}],"parameters":[{"id":3116,"name":"delay","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/common/function/Debounce","previousId":3112,"nextId":3117},{"id":3117,"name":"Deprecate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Deprecate.d.ts","line":6,"character":24}],"signatures":[{"id":3118,"name":"Deprecate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A decorator that marks a class declaration, class method,\\nclass property, or method parameter as deprecated by\\nlogging a deprecation message to the console."}]},"sources":[{"fileName":"packages/decorators/mjs/Deprecate.d.ts","line":6,"character":24}],"parameters":[{"id":3119,"name":"message","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reflection","declaration":{"id":3120,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Deprecate.d.ts","line":6,"character":53}],"signatures":[{"id":3121,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":3122,"name":"target","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Function"},"name":"Function","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Object"},"name":"Object","package":"typescript"}]}},{"id":3123,"name":"property","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"symbol"}]}},{"id":3124,"name":"descriptor","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"permalink":"/api/common/function/Deprecate","previousId":3114,"nextId":3125},{"id":3125,"name":"Memoize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":25,"character":24}],"signatures":[{"id":3126,"name":"Memoize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that caches the return value of a class method or\\ngetter to consistently and efficiently return the same value."}]},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":25,"character":24}],"typeParameter":[{"id":3127,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":3128,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":3134,"name":"MemoizeHasher","package":"@boost/decorators"},{"type":"reference","target":3143,"typeArguments":[{"type":"reference","target":3127,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}],"name":"MemoizeOptions","package":"@boost/decorators"}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/common/function/Memoize","previousId":3117,"nextId":3148},{"id":3148,"name":"Throttle","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Throttle.d.ts","line":5,"character":24}],"signatures":[{"id":3149,"name":"Throttle","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that throttles the execution of a class method to\\nonly fire once within every delay timeframe (in milliseconds)."}]},"sources":[{"fileName":"packages/decorators/mjs/Throttle.d.ts","line":5,"character":24}],"parameters":[{"id":3150,"name":"delay","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/common/function/Throttle","previousId":3125,"nextId":2684},{"id":2684,"name":"createBlueprint","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/createBlueprint.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/createBlueprint.ts#L21"}],"signatures":[{"id":2685,"name":"createBlueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to generate a blueprint object for use within\\n[optimal](https://github.com/milesj/optimal) checks. All supported optimal\\nschemas are passed as an object to the factory.\\n\\n"},{"kind":"code","text":"```ts\\nimport { createBlueprint } from \'@boost/common\';\\nimport { optimal } from \'@boost/common/optimal\';\\n\\nconst blueprint = createBlueprint(({ string, number }) => ({\\n\\tname: string().required(),\\n\\tage: number().gt(0),\\n}));\\n\\nconst object = optimal(blueprint).validate({});\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/createBlueprint.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/createBlueprint.ts#L21"}],"typeParameter":[{"id":2686,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2687,"name":"factory","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2949,"typeArguments":[{"type":"reference","target":2686,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"BlueprintFactory","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":2686,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"Blueprint","package":"optimal"}}],"permalink":"/api/common/function/createBlueprint","previousId":3148,"nextId":2688},{"id":2688,"name":"deepFreeze","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepFreeze.ts","line":15,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepFreeze.ts#L15"}],"signatures":[{"id":2689,"name":"deepFreeze","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to recursively freeze plain objects with "},{"kind":"code","text":"`Object.freeze`"},{"kind":"text","text":".\\n\\n"},{"kind":"code","text":"```ts\\nimport { deepFreeze } from \'@boost/common\';\\n\\nconst obj = deepFreeze({ foo: 123 });\\n\\n// Errors!\\nobj.foo = 456;\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/deepFreeze.ts","line":15,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepFreeze.ts#L15"}],"typeParameter":[{"id":2690,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2691,"name":"obj","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2690,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"type":{"type":"reference","target":2690,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/function/deepFreeze","previousId":2684,"nextId":2692},{"id":2692,"name":"deepMerge","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":44,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L44"}],"signatures":[{"id":2693,"name":"deepMerge","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to recursively merge objects and arrays, where values on the\\nright-hand side will overwrite values on the left-hand based on the key\\nor index respectively. Furthermore, if the 2nd argument is not provided,\\nit will simply clone the base value.\\n\\n"},{"kind":"code","text":"```ts\\nimport { deepMerge } from \'@boost/common\';\\n\\nconst obj = deepMerge({ foo: 123, bar: \'abc\' }, { foo: 456, baz: true });\\n\\n// -> { foo: 456, bar: \'abc\', baz: true }\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":44,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L44"}],"typeParameter":[{"id":2694,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2700,"name":"Mergeable","package":"@boost/common"}},{"id":2695,"name":"V","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2700,"name":"Mergeable","package":"@boost/common"}}],"parameters":[{"id":2696,"name":"base","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2694,"name":"T","package":"@boost/common","refersToTypeParameter":true}},{"id":2697,"name":"other","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2695,"name":"V","package":"@boost/common","refersToTypeParameter":true}}],"type":{"type":"reference","target":2694,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/function/deepMerge","previousId":2688,"nextId":2703},{"id":2703,"name":"formatMs","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/formatMs.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/formatMs.ts#L14"}],"signatures":[{"id":2704,"name":"formatMs","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to format a UNIX timestamp in milliseconds into a shorthand human readable format.\\nWraps the [pretty-ms](https://www.npmjs.com/package/pretty-ms) package to handle infinite\\nnumbers, zeros, and more.\\n\\n"},{"kind":"code","text":"```ts\\nimport { formatMs } from \'@boost/common\';\\n\\nformatMs(1337000000); // 15d 11h 23m 20s\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/formatMs.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/formatMs.ts#L14"}],"parameters":[{"id":2705,"name":"ms","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":2706,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/pretty-ms/index.d.ts","qualifiedName":"Options"},"name":"Options","package":"pretty-ms"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/common/function/formatMs","previousId":2692,"nextId":2707},{"id":2707,"name":"instanceOf","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/instanceOf.ts","line":32,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/instanceOf.ts#L32"}],"signatures":[{"id":2708,"name":"instanceOf","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Performs a loose instance check by comparing class names up the prototype\\nchain if "},{"kind":"code","text":"`instanceof`"},{"kind":"text","text":" initially fails. To disable this loose check,\\npass "},{"kind":"code","text":"`false`"},{"kind":"text","text":" as the 3rd argument.\\n\\n"},{"kind":"code","text":"```ts\\nimport { instanceOf } from \'@boost/common\';\\n\\nif (instanceOf(error, Error)) {\\n\\tconsole.log(error.stack);\\n}\\n```"},{"kind":"text","text":"\\n\\nGenerics can be used to type the object being checked. This will default\\nto the declaration passed to the 2nd argument.\\n\\n"},{"kind":"code","text":"```ts\\ninstanceOf(error, Error);\\n```"},{"kind":"text","text":"\\n\\n> Loose checks can be useful if multiple copies of the same class declaration\\n> exists in the module tree. For example, multiple versions of the same package are imported."}]},"sources":[{"fileName":"packages/common/src/helpers/instanceOf.ts","line":32,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/instanceOf.ts#L32"}],"typeParameter":[{"id":2709,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":2710,"name":"object","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":2711,"name":"declaration","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2947,"typeArguments":[{"type":"reference","target":2709,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"Constructor","package":"@boost/common"}},{"id":2712,"name":"loose","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true"}],"type":{"type":"predicate","name":"object","asserts":false,"targetType":{"type":"reference","target":2709,"name":"T","package":"@boost/common","refersToTypeParameter":true}}}],"permalink":"/api/common/function/instanceOf","previousId":2703,"nextId":2713},{"id":2713,"name":"isEmpty","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isEmpty.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isEmpty.ts#L17"}],"signatures":[{"id":2714,"name":"isEmpty","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`true`"},{"kind":"text","text":" if an object has no properties, an array has no items,\\nor the value is falsy, otherwise, it returns "},{"kind":"code","text":"`false`"},{"kind":"text","text":".\\n\\n"},{"kind":"code","text":"```ts\\nimport { isEmpty } from \'@boost/common\';\\n\\nisEmpty({}); // true\\nisEmpty({ name: \'Boost\' }); // false\\n\\nisEmpty([]); // true\\nisEmpty([\'Boost\']); // false\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isEmpty.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isEmpty.ts#L17"}],"parameters":[{"id":2715,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/common/function/isEmpty","previousId":2707,"nextId":2716},{"id":2716,"name":"isFilePath","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isFilePath.ts","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isFilePath.ts#L20"}],"signatures":[{"id":2717,"name":"isFilePath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`true`"},{"kind":"text","text":" if a string or "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance looks like a file system path,\\nby checking for absolute or relative path markers, or the existence of\\npath separating slashes. Will return "},{"kind":"code","text":"`false`"},{"kind":"text","text":" for values that are only\\nthe file or folder name.\\n\\n"},{"kind":"code","text":"```ts\\nimport { isFilePath } from \'@boost/common\';\\n\\nisFilePath(\'./path/to/file.ts\'); // true\\nisFilePath(new Path(\'/path/to/folder\')); // true\\nisFilePath(\'file.ts\'); // false\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isFilePath.ts","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isFilePath.ts#L20"}],"parameters":[{"id":2718,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/common/function/isFilePath","previousId":2713,"nextId":2719},{"id":2719,"name":"isModuleName","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isModuleName.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isModuleName.ts#L21"}],"signatures":[{"id":2720,"name":"isModuleName","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`true`"},{"kind":"text","text":" if a string is a valid Node module package name,\\naccording to the rules defined in\\n[validate-npm-package-name](https://github.com/npm/validate-npm-package-name).\\nWill "},{"kind":"code","text":"`return`"},{"kind":"text","text":" false for native builtin modules, like "},{"kind":"code","text":"`fs`"},{"kind":"text","text":", and for the old name format.\\n\\n"},{"kind":"code","text":"```ts\\nimport { isModuleName } from \'@boost/common\';\\n\\nisModuleName(\'boost\'); // true\\nisModuleName(\'@boost/common\'); // true\\nisModuleName(\'fs\'); // false\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isModuleName.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isModuleName.ts#L21"}],"parameters":[{"id":2721,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/common/function/isModuleName","previousId":2716,"nextId":2722},{"id":2722,"name":"isObject","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isObject.ts","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isObject.ts#L24"}],"signatures":[{"id":2723,"name":"isObject","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`true`"},{"kind":"text","text":" if the value is an object.\\n\\n"},{"kind":"code","text":"```ts\\nimport { isObject } from \'@boost/common\';\\n\\nisObject({}); // true\\nisObject(new Foo()); // true\\nisObject([]); // false\\n```"},{"kind":"text","text":"\\n\\nGenerics can be used to type the return value of the object (when necessary).\\n\\n"},{"kind":"code","text":"```ts\\ninterface Person {\\n\\tname: string;\\n}\\n\\nif (isObject(person)) {\\n\\tconsole.log(person.name);\\n}\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isObject.ts","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isObject.ts#L24"}],"typeParameter":[{"id":2724,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2725,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"predicate","name":"value","asserts":false,"targetType":{"type":"reference","target":2724,"name":"T","package":"@boost/common","refersToTypeParameter":true}}}],"permalink":"/api/common/function/isObject","previousId":2719,"nextId":2726},{"id":2726,"name":"isPlainObject","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isPlainObject.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isPlainObject.ts#L17"}],"signatures":[{"id":2727,"name":"isPlainObject","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`isObject`"},{"kind":"text","text":" but only returns true if the value is a plain object\\n(no class instances, built-ins, etc). It achieves this by comparing\\nthe value\'s prototype to the built-in "},{"kind":"code","text":"`Object`"},{"kind":"text","text":" types. If you need to\\nrun these checks for cross-realm objects, pass true to the "},{"kind":"code","text":"`loose`"},{"kind":"text","text":" argument.\\n\\n"},{"kind":"code","text":"```ts\\nimport { isPlainObject } from \'@boost/common\';\\n\\nisPlainObject({}); // true\\nisPlainObject(new Foo()); // false\\nisPlainObject([]); // false\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isPlainObject.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isPlainObject.ts#L17"}],"typeParameter":[{"id":2728,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2729,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":2730,"name":"loose","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"predicate","name":"value","asserts":false,"targetType":{"type":"reference","target":2728,"name":"T","package":"@boost/common","refersToTypeParameter":true}}}],"permalink":"/api/common/function/isPlainObject","previousId":2722,"nextId":2731},{"id":2731,"name":"toArray","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/toArray.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/toArray.ts#L14"}],"signatures":[{"id":2732,"name":"toArray","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Converts a non-array to an array. If the provided value is falsy,\\nan empty array is returned. If the provided value is truthy and a\\nnon-array, an array of 1 item is returned.\\n\\n"},{"kind":"code","text":"```ts\\nimport { toArray } from \'@boost/common\';\\n\\ntoArray(123); // [123]\\ntoArray(\'abc\'); // [\'abc\']\\ntoArray([\'a\', \'b\', \'c\']); // [\'a\', \'b\', \'c\']\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/toArray.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/toArray.ts#L14"}],"typeParameter":[{"id":2733,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":2734,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":2733,"name":"T","package":"@boost/common","refersToTypeParameter":true},{"type":"array","elementType":{"type":"reference","target":2733,"name":"T","package":"@boost/common","refersToTypeParameter":true}}]}}],"type":{"type":"array","elementType":{"type":"reference","target":2733,"name":"T","package":"@boost/common","refersToTypeParameter":true}}}],"permalink":"/api/common/function/toArray","previousId":2726,"nextId":2965}],"groups":[{"title":"Classes","children":[2659,2678,2735,2763,2802,2859,2890,3055]},{"title":"Functions","children":[3112,3114,3117,3125,3148,2684,2688,2692,2703,2707,2713,2716,2719,2722,2726,2731]},{"title":"Interfaces","children":[2965,2969,2929,3143,2955,3041,3037,2986,2913,2976,2978,2888,2982,2933,2960,2973,3045,3051]},{"title":"Namespaces","children":[2610,2637]},{"title":"Type Aliases","children":[2937,2949,2651,2942,2964,2947,2968,2927,2701,2928,3138,3134,3129,2698,2699,2700,2921,2922,2920,2962]},{"title":"Variables","children":[2652,2657,2658]}],"sources":[{"fileName":"packages/common/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/index.ts#L1"}],"permalink":"/api/common"},"urlSlug":"common"},{"index":false,"label":"Optimal","reflection":{"id":89,"name":"@boost/common/optimal","variant":"declaration","kind":2,"flags":{},"children":[{"id":90,"name":"portablePathSchema","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"A schema for validating a value is a "},{"kind":"code","text":"`PortablePath`"},{"kind":"text","text":".\\nChecks for a string, "},{"kind":"code","text":"`Path`"},{"kind":"text","text":", or "},{"kind":"code","text":"`Pathable`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/common/src/optimal.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/optimal.ts#L11"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/union.d.ts","qualifiedName":"UnionSchema"},"typeArguments":[{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}],"name":"UnionSchema","package":"optimal"},"defaultValue":"...","permalink":"/api/common-optimal#portablePathSchema"}],"groups":[{"title":"Variables","children":[90]}],"sources":[{"fileName":"packages/common/src/optimal.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/optimal.ts#L1"}],"permalink":"/api/common-optimal"},"urlSlug":"common-optimal"},{"index":false,"label":"Test utilities","reflection":{"id":75,"name":"@boost/common/test","variant":"declaration","kind":2,"flags":{},"children":[{"id":80,"name":"mockFilePath","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":19,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L19"}],"signatures":[{"id":81,"name":"mockFilePath","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":19,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L19"}],"parameters":[{"id":82,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}],"permalink":"/api/common-test/function/mockFilePath","nextId":86},{"id":86,"name":"mockModulePath","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":30,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L30"}],"signatures":[{"id":87,"name":"mockModulePath","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":30,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L30"}],"parameters":[{"id":88,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2735,"name":"ModulePath","package":"@boost/common"}}],"permalink":"/api/common-test/function/mockModulePath","previousId":80,"nextId":83},{"id":83,"name":"mockNormalizedFilePath","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L23"}],"signatures":[{"id":84,"name":"mockNormalizedFilePath","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L23"}],"parameters":[{"id":85,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}],"permalink":"/api/common-test/function/mockNormalizedFilePath","previousId":86,"nextId":76},{"id":76,"name":"normalizeSeparators","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L7"}],"signatures":[{"id":77,"name":"normalizeSeparators","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize a path or its parts by ensuring all path separators match\\nthe operating systems default character."}]},"sources":[{"fileName":"packages/common/src/test.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L7"}],"typeParameter":[{"id":78,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"},{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}]}}],"parameters":[{"id":79,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":78,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"type":{"type":"reference","target":78,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common-test/function/normalizeSeparators","previousId":83}],"groups":[{"title":"Functions","children":[80,86,83,76]}],"sources":[{"fileName":"packages/common/src/test.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L1"}],"permalink":"/api/common-test"},"urlSlug":"common-test"}],"packageName":"@boost/common","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":2,"name":"@boost/config","variant":"declaration","kind":2,"flags":{},"children":[{"id":347,"name":"Configuration","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":348,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":44,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L44"}],"signatures":[{"id":349,"name":"new Configuration","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":44,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L44"}],"typeParameter":[{"id":350,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":351,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":352,"name":"resolver","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"ModuleResolver"},"name":"ModuleResolver","package":"@boost/common"}}],"type":{"type":"reference","target":347,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Configuration","package":"@boost/config"},"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":353,"name":"onLoadedConfig","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after config files are loaded but before processed. Can modify config file list."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":22,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L22"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/WaterfallEvent.ts","qualifiedName":"WaterfallEvent"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":479,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"ConfigFile","package":"@boost/config"}},{"type":"intrinsic","name":"string"}],"name":"WaterfallEvent","package":"@boost/event"},"defaultValue":"..."},{"id":354,"name":"onLoadedIgnore","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after ignore files are loaded. Can modify ignore file list."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":28,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L28"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/WaterfallEvent.ts","qualifiedName":"WaterfallEvent"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":484,"name":"IgnoreFile","package":"@boost/config"}},{"type":"intrinsic","name":"string"}],"name":"WaterfallEvent","package":"@boost/event"},"defaultValue":"..."},{"id":355,"name":"onProcessedConfig","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after config files are loaded and processed."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":34,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L34"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":407,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":384,"name":"addProcessHandler","variant":"declaration","kind":2048,"flags":{"isPublic":true},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":150,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L150"}],"signatures":[{"id":385,"name":"addProcessHandler","variant":"signature","kind":4096,"flags":{"isPublic":true},"comment":{"summary":[{"kind":"text","text":"Add a process handler to customize the processing of key-value setting pairs.\\nMay only run a processor on settings found in the root of the configuration object."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":150,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L150"}],"typeParameter":[{"id":386,"name":"K","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"symbol"}]}},{"id":387,"name":"V","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"indexedAccess","indexType":{"type":"reference","target":386,"name":"K","package":"@boost/config","refersToTypeParameter":true},"objectType":{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}}}],"parameters":[{"id":388,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":386,"name":"K","package":"@boost/config","refersToTypeParameter":true}},{"id":389,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":468,"typeArguments":[{"type":"reference","target":387,"name":"V","package":"@boost/config","refersToTypeParameter":true}],"name":"Handler","package":"@boost/config"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":414,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"signatures":[{"id":415,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"parameters":[{"id":416,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":417,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":390,"name":"bootstrap","variant":"declaration","kind":2048,"flags":{"isPublic":true},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":160,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L160"}],"signatures":[{"id":391,"name":"bootstrap","variant":"signature","kind":4096,"flags":{"isPublic":true},"comment":{"summary":[{"kind":"text","text":"Life cycle called on initialization."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":160,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L160"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":360,"name":"clearCache","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":57,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L57"}],"signatures":[{"id":361,"name":"clearCache","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clear all cache."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":57,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L57"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":362,"name":"clearFileCache","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L67"}],"signatures":[{"id":363,"name":"clearFileCache","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clear all cached file contents."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L67"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":364,"name":"clearFinderCache","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L76"}],"signatures":[{"id":365,"name":"clearFinderCache","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clear all cached directory and file path information."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L76"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":408,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":409,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":410,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":411,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":412,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":413,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":392,"name":"configureFinder","variant":"declaration","kind":2048,"flags":{"isPublic":true},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":166,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L166"}],"signatures":[{"id":393,"name":"configureFinder","variant":"signature","kind":4096,"flags":{"isPublic":true},"comment":{"summary":[{"kind":"text","text":"Configure the finder instance."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":166,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L166"}],"parameters":[{"id":394,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":495,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"ConfigFinderOptions","package":"@boost/config"},{"type":"literal","value":"name"}],"name":"Omit","package":"typescript"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":395,"name":"configureProcessor","variant":"declaration","kind":2048,"flags":{"isPublic":true},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":176,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L176"}],"signatures":[{"id":396,"name":"configureProcessor","variant":"signature","kind":4096,"flags":{"isPublic":true},"comment":{"summary":[{"kind":"text","text":"Configure the processor instance."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":176,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L176"}],"parameters":[{"id":397,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":516,"name":"ProcessorOptions","package":"@boost/config"},{"type":"literal","value":"name"}],"name":"Omit","package":"typescript"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":366,"name":"findRootDir","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":87,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L87"}],"signatures":[{"id":367,"name":"findRootDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Attempt to find the root directory starting from the provided directory.\\nOnce the root is found, it will be cached for further lookups,\\notherwise an error is thrown based on current configuration."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":87,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L87"}],"parameters":[{"id":368,"name":"fromDir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},"defaultValue":"..."}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"}],"name":"Promise","package":"typescript"}}]},{"id":369,"name":"loadConfigFromBranchToRoot","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":96,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L96"}],"signatures":[{"id":370,"name":"loadConfigFromBranchToRoot","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Traverse upwards from the branch directory, until the root directory is found,\\nor we reach to top of the file system. While traversing, find all config files\\nwithin each branch directory, and the root."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":96,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L96"}],"parameters":[{"id":371,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":488,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"ProcessedConfig","package":"@boost/config"}],"name":"Promise","package":"typescript"}}]},{"id":372,"name":"loadConfigFromRoot","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":106,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L106"}],"signatures":[{"id":373,"name":"loadConfigFromRoot","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Load config files from the defined root. Root is determined by a relative\\n"},{"kind":"code","text":"`.config`"},{"kind":"text","text":" folder and "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" file."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":106,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L106"}],"parameters":[{"id":374,"name":"fromDir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},"defaultValue":"..."}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":488,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"ProcessedConfig","package":"@boost/config"}],"name":"Promise","package":"typescript"}}]},{"id":375,"name":"loadIgnoreFromBranchToRoot","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":117,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L117"}],"signatures":[{"id":376,"name":"loadIgnoreFromBranchToRoot","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Traverse upwards from the branch directory, until the root directory is found,\\nor we reach to top of the file system. While traversing, find all ignore files\\nwithin each branch directory, and the root."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":117,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L117"}],"parameters":[{"id":377,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":484,"name":"IgnoreFile","package":"@boost/config"}}],"name":"Promise","package":"typescript"}}]},{"id":378,"name":"loadIgnoreFromRoot","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":127,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L127"}],"signatures":[{"id":379,"name":"loadIgnoreFromRoot","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Load ignore file from the defined root. Root is determined by a relative\\n"},{"kind":"code","text":"`.config`"},{"kind":"text","text":" folder and "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" file."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":127,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L127"}],"parameters":[{"id":380,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},"defaultValue":"..."}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":484,"name":"IgnoreFile","package":"@boost/config"}}],"name":"Promise","package":"typescript"}}]},{"id":381,"name":"setRootDir","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":139,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L139"}],"signatures":[{"id":382,"name":"setRootDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Explicitly set the root directory to stop traversal at. This should only be set\\nmanually when you want full control, and know file boundaries up front.\\n\\nThis *does not* check for the existence of the root config file or folder."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":139,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L139"}],"parameters":[{"id":383,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[348]},{"title":"Properties","children":[353,354,355,407]},{"title":"Methods","children":[384,414,390,360,362,364,408,392,395,366,369,372,375,378,381]}],"categories":[{"title":"Events","children":[353,354,355]},{"title":"__CATEGORY__","children":[348,407,384,414,390,360,362,364,408,392,395,366,369,372,375,378,381]}],"sources":[{"fileName":"packages/config/src/Configuration.ts","line":17,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L17"}],"typeParameters":[{"id":418,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}],"permalink":"/api/config/class/Configuration","nextId":445},{"id":492,"name":"BaseFinderOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":494,"name":"errorIfNoRootFound","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error if the root config cannot be located."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L45"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":493,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of files, without extension."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L43"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[494,493]}],"sources":[{"fileName":"packages/config/src/types.ts","line":41,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L41"}],"extendedBy":[{"type":"reference","target":495,"name":"ConfigFinderOptions"},{"type":"reference","target":513,"name":"IgnoreFinderOptions"}],"permalink":"/api/config/interface/BaseFinderOptions","previousId":440,"nextId":479},{"id":479,"name":"ConfigFile","variant":"declaration","kind":256,"flags":{},"children":[{"id":480,"name":"config","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Config content of the file."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L25"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"DeepPartial"},"typeArguments":[{"type":"reference","target":483,"name":"T","package":"@boost/config","qualifiedName":"ConfigFile.T","refersToTypeParameter":true}],"name":"DeepPartial","package":"optimal"}},{"id":481,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute path of the file."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":477,"name":"File.path"}},{"id":482,"name":"source","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The source where the file originated."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L20"}],"type":{"type":"reference","target":475,"name":"FileSource","package":"@boost/config"},"inheritedFrom":{"type":"reference","target":478,"name":"File.source"}}],"groups":[{"title":"Properties","children":[480,481,482]}],"sources":[{"fileName":"packages/config/src/types.ts","line":23,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L23"}],"typeParameters":[{"id":483,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"extendedTypes":[{"type":"reference","target":476,"name":"File","package":"@boost/config"}],"permalink":"/api/config/interface/ConfigFile","previousId":492,"nextId":495},{"id":495,"name":"ConfigFinderOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":511,"name":"errorIfNoRootFound","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error if the root config cannot be located."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L45"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":494,"name":"BaseFinderOptions.errorIfNoRootFound"}},{"id":496,"name":"extendsSetting","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Name of the setting in which \\"config extending\\" is enabled."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L50"}],"type":{"type":"intrinsic","name":"string"}},{"id":497,"name":"extensions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of extensions, in order, to find config files within each folder. Defaults to built-in file format list."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":52,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L52"}],"type":{"type":"array","elementType":{"type":"reference","target":460,"name":"ExtType","package":"@boost/config"}}},{"id":498,"name":"includeEnv","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Find and load environment based config files (using "},{"kind":"code","text":"`NODE_ENV`"},{"kind":"text","text":"). Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":54,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L54"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":499,"name":"loaders","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mapping of loader functions by type. Defaults to built-in file type loaders."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":56,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L56"}],"type":{"type":"reflection","declaration":{"id":500,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":501,"name":"cjs","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":502,"name":"js","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":503,"name":"json","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":504,"name":"json5","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":505,"name":"mjs","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":506,"name":"ts","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":507,"name":"yaml","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}}],"groups":[{"title":"Properties","children":[501,502,503,504,505,506,507]}],"sources":[{"fileName":"packages/config/src/types.ts","line":56,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L56"}]}}},{"id":510,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of files, without extension."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L43"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":493,"name":"BaseFinderOptions.name"}},{"id":508,"name":"overridesSetting","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Name of the setting in which \\"config overriding\\" is enabled."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L58"}],"type":{"type":"intrinsic","name":"string"}},{"id":509,"name":"resolver","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom module resolver."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":60,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L60"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"ModuleResolver"},"name":"ModuleResolver","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[511,496,497,498,499,510,508,509]}],"sources":[{"fileName":"packages/config/src/types.ts","line":48,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L48"}],"typeParameters":[{"id":512,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"extendedTypes":[{"type":"reference","target":492,"name":"BaseFinderOptions","package":"@boost/config"}],"permalink":"/api/config/interface/ConfigFinderOptions","previousId":479,"nextId":476},{"id":476,"name":"File","variant":"declaration","kind":256,"flags":{},"children":[{"id":477,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute path of the file."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"}},{"id":478,"name":"source","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The source where the file originated."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L20"}],"type":{"type":"reference","target":475,"name":"FileSource","package":"@boost/config"}}],"groups":[{"title":"Properties","children":[477,478]}],"sources":[{"fileName":"packages/config/src/types.ts","line":16,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L16"}],"extendedBy":[{"type":"reference","target":479,"name":"ConfigFile"},{"type":"reference","target":484,"name":"IgnoreFile"}],"permalink":"/api/config/interface/File","previousId":495,"nextId":484},{"id":484,"name":"IgnoreFile","variant":"declaration","kind":256,"flags":{},"children":[{"id":485,"name":"ignore","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Ignored content of the file, split on new lines."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L30"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":486,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute path of the file."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":477,"name":"File.path"}},{"id":487,"name":"source","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The source where the file originated."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L20"}],"type":{"type":"reference","target":475,"name":"FileSource","package":"@boost/config"},"inheritedFrom":{"type":"reference","target":478,"name":"File.source"}}],"groups":[{"title":"Properties","children":[485,486,487]}],"sources":[{"fileName":"packages/config/src/types.ts","line":28,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L28"}],"extendedTypes":[{"type":"reference","target":476,"name":"File","package":"@boost/config"}],"permalink":"/api/config/interface/IgnoreFile","previousId":476,"nextId":513},{"id":513,"name":"IgnoreFinderOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":515,"name":"errorIfNoRootFound","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error if the root config cannot be located."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L45"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":494,"name":"BaseFinderOptions.errorIfNoRootFound"}},{"id":514,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of files, without extension."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L43"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":493,"name":"BaseFinderOptions.name"}}],"groups":[{"title":"Properties","children":[515,514]}],"sources":[{"fileName":"packages/config/src/types.ts","line":63,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L63"}],"extendedTypes":[{"type":"reference","target":492,"name":"BaseFinderOptions","package":"@boost/config"}],"permalink":"/api/config/interface/IgnoreFinderOptions","previousId":484,"nextId":522},{"id":522,"name":"OverridesSettingItem","variant":"declaration","kind":256,"flags":{},"children":[{"id":523,"name":"exclude","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"File path patterns/globs to ignore."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L84"}],"type":{"type":"reference","target":520,"name":"FileGlob","package":"@boost/config"}},{"id":524,"name":"include","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"File path patterns/globs to match against."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":86,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L86"}],"type":{"type":"reference","target":520,"name":"FileGlob","package":"@boost/config"}},{"id":525,"name":"settings","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Settings configured for this specific override."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":88,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L88"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"DeepPartial"},"typeArguments":[{"type":"reference","target":526,"name":"T","package":"@boost/config","qualifiedName":"OverridesSettingItem.T","refersToTypeParameter":true}],"name":"DeepPartial","package":"optimal"}}],"groups":[{"title":"Properties","children":[523,524,525]}],"sources":[{"fileName":"packages/config/src/types.ts","line":82,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L82"}],"typeParameters":[{"id":526,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/config/interface/OverridesSettingItem","previousId":513,"nextId":488},{"id":488,"name":"ProcessedConfig","variant":"declaration","kind":256,"flags":{},"children":[{"id":489,"name":"config","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"All found and loaded config file contents merged and processed into a\\nsingle config object."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":491,"name":"T","package":"@boost/config","qualifiedName":"ProcessedConfig.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}},{"id":490,"name":"files","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of config files found and loaded."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L38"}],"type":{"type":"array","elementType":{"type":"reference","target":479,"typeArguments":[{"type":"reference","target":491,"name":"T","package":"@boost/config","qualifiedName":"ProcessedConfig.T","refersToTypeParameter":true}],"name":"ConfigFile","package":"@boost/config"}}}],"groups":[{"title":"Properties","children":[489,490]}],"sources":[{"fileName":"packages/config/src/types.ts","line":33,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L33"}],"typeParameters":[{"id":491,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/config/interface/ProcessedConfig","previousId":522,"nextId":516},{"id":516,"name":"ProcessorOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":517,"name":"defaultWhenUndefined","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"When a setting has a value of "},{"kind":"code","text":"`undefined`"},{"kind":"text","text":", fallback to the\\ndefault/initial value for that setting. Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L70"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":518,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of config files, without extension."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":72,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L72"}],"type":{"type":"intrinsic","name":"string"}},{"id":519,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Validate all settings within a config file before processing. Defaults to\\n"},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":75,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L75"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[517,518,519]}],"sources":[{"fileName":"packages/config/src/types.ts","line":65,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L65"}],"permalink":"/api/config/interface/ProcessorOptions","previousId":488,"nextId":341},{"id":341,"name":"ConfigErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/ConfigError.ts","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/ConfigError.ts#L15"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/config/src/ConfigError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/config","preferValues":true}}},"permalink":"/api/config#ConfigErrorCode","previousId":516,"nextId":460},{"id":460,"name":"ExtType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":4,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L4"}],"type":{"type":"union","types":[{"type":"literal","value":"cjs"},{"type":"literal","value":"js"},{"type":"literal","value":"json"},{"type":"literal","value":"json5"},{"type":"literal","value":"mjs"},{"type":"literal","value":"ts"},{"type":"literal","value":"yaml"},{"type":"literal","value":"yml"}]},"permalink":"/api/config#ExtType","previousId":341,"nextId":521},{"id":521,"name":"ExtendsSetting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":80,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L80"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"intrinsic","name":"string"}]},"permalink":"/api/config#ExtendsSetting","previousId":460,"nextId":520},{"id":520,"name":"FileGlob","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":78,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L78"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"intrinsic","name":"string"}]},"permalink":"/api/config#FileGlob","previousId":521,"nextId":475},{"id":475,"name":"FileSource","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":14,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L14"}],"type":{"type":"union","types":[{"type":"literal","value":"branch"},{"type":"literal","value":"extended"},{"type":"literal","value":"overridden"},{"type":"literal","value":"root"}]},"permalink":"/api/config#FileSource","previousId":520,"nextId":474},{"id":474,"name":"FileType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":12,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L12"}],"type":{"type":"union","types":[{"type":"literal","value":"branch"},{"type":"literal","value":"preset"},{"type":"literal","value":"root-file"},{"type":"literal","value":"root-folder"}]},"permalink":"/api/config#FileType","previousId":475,"nextId":468},{"id":468,"name":"Handler","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":10,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L10"}],"typeParameters":[{"id":473,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":469,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":10,"character":25,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L10"}],"signatures":[{"id":470,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":471,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":473,"name":"T","package":"@boost/config","refersToTypeParameter":true}},{"id":472,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":473,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"reference","target":473,"name":"T","package":"@boost/config","refersToTypeParameter":true},{"type":"intrinsic","name":"undefined"}]}],"name":"Promise","package":"typescript"},{"type":"reference","target":473,"name":"T","package":"@boost/config","refersToTypeParameter":true},{"type":"intrinsic","name":"undefined"}]}}]}},"permalink":"/api/config#Handler","previousId":474,"nextId":462},{"id":462,"name":"Loader","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":8,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L8"}],"typeParameters":[{"id":467,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":463,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":8,"character":24,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L8"}],"signatures":[{"id":464,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":465,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"}},{"id":466,"name":"pkg","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PackageStructure"},"name":"PackageStructure","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"DeepPartial"},"typeArguments":[{"type":"reference","target":467,"name":"T","package":"@boost/config","refersToTypeParameter":true}],"name":"DeepPartial","package":"optimal"}],"name":"Promise","package":"typescript"}}]}},"permalink":"/api/config#Loader","previousId":468,"nextId":461},{"id":461,"name":"LoaderType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":6,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L6"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Exclude"},"typeArguments":[{"type":"reference","target":460,"name":"ExtType","package":"@boost/config"},{"type":"literal","value":"yml"}],"name":"Exclude","package":"typescript"},"permalink":"/api/config#LoaderType","previousId":462,"nextId":527},{"id":527,"name":"OverridesSetting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":91,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L91"}],"typeParameters":[{"id":528,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"array","elementType":{"type":"reference","target":522,"typeArguments":[{"type":"reference","target":528,"name":"T","package":"@boost/config","refersToTypeParameter":true}],"name":"OverridesSettingItem","package":"@boost/config"}},"permalink":"/api/config#OverridesSetting","previousId":461,"nextId":530},{"id":530,"name":"PluginEntry","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":97,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L97"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":529,"name":"PluginOptions","package":"@boost/config"}]}]},"permalink":"/api/config#PluginEntry","previousId":527,"nextId":529},{"id":529,"name":"PluginOptions","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":95,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L95"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"object"}]},"permalink":"/api/config#PluginOptions","previousId":530,"nextId":533},{"id":533,"name":"PluginsSetting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":103,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L103"}],"type":{"type":"union","types":[{"type":"reference","target":532,"name":"PluginsSettingList","package":"@boost/config"},{"type":"reference","target":531,"name":"PluginsSettingMap","package":"@boost/config"}]},"permalink":"/api/config#PluginsSetting","previousId":529,"nextId":532},{"id":532,"name":"PluginsSettingList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":101,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L101"}],"type":{"type":"array","elementType":{"type":"reference","target":530,"name":"PluginEntry","package":"@boost/config"}},"permalink":"/api/config#PluginsSettingList","previousId":533,"nextId":531},{"id":531,"name":"PluginsSettingMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":99,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L99"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":529,"name":"PluginOptions","package":"@boost/config"}],"name":"Record","package":"typescript"},"permalink":"/api/config#PluginsSettingMap","previousId":532,"nextId":342},{"id":342,"name":"ConfigError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/config/src/ConfigError.ts","line":17,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/ConfigError.ts#L17"}],"type":{"type":"reflection","declaration":{"id":343,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":344,"name":"new ConfigError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":345,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"EXTENDS_ONLY_ROOT"},{"type":"literal","value":"EXTENDS_UNKNOWN_PATH"},{"type":"literal","value":"LOADER_UNSUPPORTED"},{"type":"literal","value":"PACKAGE_UNKNOWN_SCOPE"},{"type":"literal","value":"ROOT_INVALID"},{"type":"literal","value":"ROOT_INVALID_DIR"},{"type":"literal","value":"ROOT_NO_PACKAGE"},{"type":"literal","value":"ROOT_ONLY_OVERRIDES"}]}},{"id":346,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"EXTENDS_ONLY_ROOT"},{"type":"literal","value":"EXTENDS_UNKNOWN_PATH"},{"type":"literal","value":"LOADER_UNSUPPORTED"},{"type":"literal","value":"PACKAGE_UNKNOWN_SCOPE"},{"type":"literal","value":"ROOT_INVALID"},{"type":"literal","value":"ROOT_INVALID_DIR"},{"type":"literal","value":"ROOT_NO_PACKAGE"},{"type":"literal","value":"ROOT_ONLY_OVERRIDES"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/config#ConfigError","previousId":531},{"id":445,"name":"createExtendsSchema","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L13"}],"signatures":[{"id":446,"name":"createExtendsSchema","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" schema for validating the structure of an \\"extends\\" setting."}]},"sources":[{"fileName":"packages/config/src/schemas.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L13"}],"parameters":[{"id":447,"name":"schematics","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"},"defaultValue":"schemas"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/union.d.ts","qualifiedName":"UnionSchema"},"typeArguments":[{"type":"reference","target":521,"name":"ExtendsSetting","package":"@boost/config"}],"name":"UnionSchema","package":"optimal"}}],"permalink":"/api/config/function/createExtendsSchema","previousId":347,"nextId":451},{"id":451,"name":"createOverridesSchema","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":39,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L39"}],"signatures":[{"id":452,"name":"createOverridesSchema","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" schema for validating the structure of an \\"overrides\\" setting."}]},"sources":[{"fileName":"packages/config/src/schemas.ts","line":39,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L39"}],"typeParameter":[{"id":453,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":454,"name":"blueprint","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":453,"name":"T","package":"@boost/config","refersToTypeParameter":true}],"name":"Blueprint","package":"optimal"}},{"id":455,"name":"schematics","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"},"defaultValue":"schemas"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/array.d.ts","qualifiedName":"ArraySchema"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":456,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":457,"name":"exclude","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":48,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L48"}],"type":{"type":"reference","target":520,"name":"FileGlob","package":"@boost/config"},"defaultValue":"..."},{"id":458,"name":"include","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":49,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L49"}],"type":{"type":"reference","target":520,"name":"FileGlob","package":"@boost/config"},"defaultValue":"..."},{"id":459,"name":"settings","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":50,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L50"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"NotNull"},"typeArguments":[{"type":"reference","target":453,"name":"T","package":"@boost/config","refersToTypeParameter":true}],"name":"NotNull","package":"optimal"}],"name":"Required","package":"typescript"},"defaultValue":"..."}],"groups":[{"title":"Properties","children":[457,458,459]}]}}],"name":"Required","package":"typescript"}}],"name":"ArraySchema","package":"optimal"}}],"permalink":"/api/config/function/createOverridesSchema","previousId":445,"nextId":448},{"id":448,"name":"createPluginsSchema","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L24"}],"signatures":[{"id":449,"name":"createPluginsSchema","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" schema for validating the structure of a \\"plugins\\" setting."}]},"sources":[{"fileName":"packages/config/src/schemas.ts","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L24"}],"parameters":[{"id":450,"name":"schematics","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"},"defaultValue":"schemas"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/union.d.ts","qualifiedName":"UnionSchema"},"typeArguments":[{"type":"reference","target":533,"name":"PluginsSetting","package":"@boost/config"}],"name":"UnionSchema","package":"optimal"}}],"permalink":"/api/config/function/createPluginsSchema","previousId":451,"nextId":419},{"id":419,"name":"getEnv","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/getEnv.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/getEnv.ts#L4"}],"signatures":[{"id":420,"name":"getEnv","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Detect the current environment name from "},{"kind":"code","text":"`_ENV`"},{"kind":"text","text":" and "},{"kind":"code","text":"`NODE_ENV`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/config/src/helpers/getEnv.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/getEnv.ts#L4"}],"parameters":[{"id":421,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/config/function/getEnv","previousId":448,"nextId":422},{"id":422,"name":"mergeArray","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/mergeArray.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeArray.ts#L4"}],"signatures":[{"id":423,"name":"mergeArray","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Merges previous and next arrays into a new array while removing duplicates (using "},{"kind":"code","text":"`Set`"},{"kind":"text","text":")."}]},"sources":[{"fileName":"packages/config/src/helpers/mergeArray.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeArray.ts#L4"}],"typeParameter":[{"id":424,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"parameters":[{"id":425,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":424,"name":"T","package":"@boost/config","refersToTypeParameter":true}},{"id":426,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":424,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"type":{"type":"reference","target":424,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"permalink":"/api/config/function/mergeArray","previousId":419,"nextId":427},{"id":427,"name":"mergeExtends","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/mergeExtends.ts","line":9,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeExtends.ts#L9"}],"signatures":[{"id":428,"name":"mergeExtends","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Merges previous and next file paths (either a string or array of strings) into a\\nnew list of file paths. This is useful if utilizing config extending."}]},"sources":[{"fileName":"packages/config/src/helpers/mergeExtends.ts","line":9,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeExtends.ts#L9"}],"parameters":[{"id":429,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":521,"name":"ExtendsSetting","package":"@boost/config"}},{"id":430,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":521,"name":"ExtendsSetting","package":"@boost/config"}}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"permalink":"/api/config/function/mergeExtends","previousId":422,"nextId":431},{"id":431,"name":"mergeObject","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/mergeObject.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeObject.ts#L4"}],"signatures":[{"id":432,"name":"mergeObject","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shallow merges previous and next objects into a new object using object spread."}]},"sources":[{"fileName":"packages/config/src/helpers/mergeObject.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeObject.ts#L4"}],"typeParameter":[{"id":433,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":434,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":433,"name":"T","package":"@boost/config","refersToTypeParameter":true}},{"id":435,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":433,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"type":{"type":"reference","target":433,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"permalink":"/api/config/function/mergeObject","previousId":427,"nextId":436},{"id":436,"name":"mergePlugins","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/mergePlugins.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergePlugins.ts#L21"}],"signatures":[{"id":437,"name":"mergePlugins","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Merges previous and next plugin configurations into an object.\\nPlugin configs can either be a list of sources, or list of sources\\nwith flags/options (tuples), or a map of sources to flags/options.\\nThis is useful if utilizing the "},{"kind":"code","text":"`@boost/plugin`"},{"kind":"text","text":" package."}]},"sources":[{"fileName":"packages/config/src/helpers/mergePlugins.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergePlugins.ts#L21"}],"parameters":[{"id":438,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":533,"name":"PluginsSetting","package":"@boost/config"}},{"id":439,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":533,"name":"PluginsSetting","package":"@boost/config"}}],"type":{"type":"reference","target":531,"name":"PluginsSettingMap","package":"@boost/config"}}],"permalink":"/api/config/function/mergePlugins","previousId":431,"nextId":440},{"id":440,"name":"overwrite","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/overwrite.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/overwrite.ts#L4"}],"signatures":[{"id":441,"name":"overwrite","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Overwrite the previous value with the next value."}]},"sources":[{"fileName":"packages/config/src/helpers/overwrite.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/overwrite.ts#L4"}],"typeParameter":[{"id":442,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":443,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":442,"name":"T","package":"@boost/config","refersToTypeParameter":true}},{"id":444,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":442,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"type":{"type":"reference","target":442,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"permalink":"/api/config/function/overwrite","previousId":436,"nextId":492}],"groups":[{"title":"Classes","children":[347]},{"title":"Functions","children":[445,451,448,419,422,427,431,436,440]},{"title":"Interfaces","children":[492,479,495,476,484,513,522,488,516]},{"title":"Type Aliases","children":[341,460,521,520,475,474,468,462,461,527,530,529,533,532,531]},{"title":"Variables","children":[342]}],"sources":[{"fileName":"packages/config/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/index.ts#L1"}],"permalink":"/api/config"},"urlSlug":"config"}],"packageName":"@boost/config","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":91,"name":"@boost/debug","variant":"declaration","kind":2,"flags":{},"children":[{"id":3151,"name":"CrashReporter","variant":"declaration","kind":128,"flags":{},"children":[{"id":3152,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":3153,"name":"new CrashReporter","variant":"signature","kind":16384,"flags":{},"type":{"type":"reference","target":3151,"name":"CrashReporter","package":"@boost/debug"}}]},{"id":3154,"name":"contents","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L38"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":3155,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L43"}],"signatures":[{"id":3156,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a label with a value, or multiple values, to the last added section."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L43"}],"parameters":[{"id":3157,"name":"label","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3158,"name":"messages","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}]}}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3159,"name":"addSection","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L53"}],"signatures":[{"id":3160,"name":"addSection","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Start a new section with a title."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L53"}],"parameters":[{"id":3161,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3162,"name":"reportBinaries","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L65"}],"signatures":[{"id":3163,"name":"reportBinaries","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report Node.js related binary versions and paths."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L65"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3164,"name":"reportEnvVars","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L92"}],"signatures":[{"id":3165,"name":"reportEnvVars","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report all environment variables."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L92"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3166,"name":"reportLanguages","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":107,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L107"}],"signatures":[{"id":3167,"name":"reportLanguages","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report common programming language versions and paths"}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":107,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L107"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3175,"name":"reportPackageVersions","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":202,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L202"}],"signatures":[{"id":3176,"name":"reportPackageVersions","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report npm package versions for all that match the defined pattern.\\nOnly searches in the root node modules folder and _will not_ work with PnP."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":202,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L202"}],"parameters":[{"id":3177,"name":"patterns","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":3178,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'Packages\'"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3168,"name":"reportProcess","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L153"}],"signatures":[{"id":3169,"name":"reportProcess","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report information about the current "},{"kind":"code","text":"`process`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L153"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3170,"name":"reportStackTrace","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L167"}],"signatures":[{"id":3171,"name":"reportStackTrace","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report the stack trace for a defined "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L167"}],"parameters":[{"id":3172,"name":"error","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3173,"name":"reportSystem","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":178,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L178"}],"signatures":[{"id":3174,"name":"reportSystem","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report information about the platform and operating system."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":178,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L178"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3179,"name":"write","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":232,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L232"}],"signatures":[{"id":3180,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write the reported content to the defined file path."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":232,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L232"}],"parameters":[{"id":3181,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[3152]},{"title":"Properties","children":[3154]},{"title":"Methods","children":[3155,3159,3162,3164,3166,3175,3168,3170,3173,3179]}],"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L37"}],"permalink":"/api/debug/class/CrashReporter","nextId":3182},{"id":3185,"name":"Debugger","variant":"declaration","kind":256,"flags":{},"children":[{"id":3186,"name":"disable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all debugger messages from logging to the console."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L7"}],"type":{"type":"reflection","declaration":{"id":3187,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":7,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L7"}],"signatures":[{"id":3188,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all debugger messages from logging to the console."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":7,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L7"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3189,"name":"enable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all debugger messages to log the console."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L9"}],"type":{"type":"reflection","declaration":{"id":3190,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":9,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L9"}],"signatures":[{"id":3191,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all debugger messages to log the console."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":9,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L9"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3192,"name":"invariant","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a pass or fail message based on a conditional."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L11"}],"type":{"type":"reflection","declaration":{"id":3193,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L11"}],"signatures":[{"id":3194,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a pass or fail message based on a conditional."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L11"}],"parameters":[{"id":3195,"name":"condition","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}},{"id":3196,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3197,"name":"pass","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3198,"name":"fail","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3199,"name":"verbose","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log verbose messages that only appear when the "},{"kind":"code","text":"`BOOSTJS_DEBUG_VERBOSE`"},{"kind":"text","text":" is set."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L13"}],"type":{"type":"reflection","declaration":{"id":3200,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":13,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L13"}],"signatures":[{"id":3201,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log verbose messages that only appear when the "},{"kind":"code","text":"`BOOSTJS_DEBUG_VERBOSE`"},{"kind":"text","text":" is set."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":13,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L13"}],"parameters":[{"id":3202,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3203,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[3186,3189,3192,3199]}],"sources":[{"fileName":"packages/debug/src/types.ts","line":3,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L3"}],"signatures":[{"id":3204,"name":"Debugger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":5,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L5"}],"parameters":[{"id":3205,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3206,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}},{"id":3207,"name":"Debugger","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":3,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L3"}],"parameters":[{"id":3208,"name":"formatter","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"any"}},{"id":3209,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/debug/index.d.ts","qualifiedName":"debug.IDebugger"},"name":"IDebugger","package":"@types/debug","qualifiedName":"debug.IDebugger"}],"permalink":"/api/debug/interface/Debugger","previousId":3182},{"id":3182,"name":"createDebugger","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/debug/src/createDebugger.ts","line":10,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/createDebugger.ts#L10"}],"signatures":[{"id":3183,"name":"createDebugger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`Debugger`"},{"kind":"text","text":" instance with the defined namespace."}]},"sources":[{"fileName":"packages/debug/src/createDebugger.ts","line":10,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/createDebugger.ts#L10"}],"parameters":[{"id":3184,"name":"namespace","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"type":{"type":"reference","target":3185,"name":"Debugger","package":"@boost/debug"}}],"permalink":"/api/debug/function/createDebugger","previousId":3151,"nextId":3185}],"groups":[{"title":"Classes","children":[3151]},{"title":"Functions","children":[3182]},{"title":"Interfaces","children":[3185]}],"sources":[{"fileName":"packages/debug/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/index.ts#L1"}],"permalink":"/api/debug"},"urlSlug":"debug"},{"index":false,"label":"Test utilities","reflection":{"id":92,"name":"@boost/debug/test","variant":"declaration","kind":2,"flags":{},"children":[{"id":93,"name":"mockDebugger","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/debug/src/test.ts","line":18,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/test.ts#L18"}],"signatures":[{"id":94,"name":"mockDebugger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a Vitest spy that matches the return value shape of "},{"kind":"code","text":"`createDebugger`"},{"kind":"text","text":".\\n\\n"},{"kind":"code","text":"```ts\\nimport { mockDebugger } from \'@boost/debug/test\';\\n\\nit(\'calls the debugger\', async () => {\\n\\tconst debug = await mockDebugger();\\n\\n\\tdebug(\'Something is broken!\');\\n\\n\\texpect(debug).toHaveBeenCalled();\\n});\\n```"}]},"sources":[{"fileName":"packages/debug/src/test.ts","line":18,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/test.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":3185,"name":"Debugger","package":"@boost/debug"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/debug-test/function/mockDebugger"}],"groups":[{"title":"Functions","children":[93]}],"sources":[{"fileName":"packages/debug/src/test.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/test.ts#L1"}],"permalink":"/api/debug-test"},"urlSlug":"debug-test"}],"packageName":"@boost/debug","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":3,"name":"@boost/decorators","variant":"declaration","kind":2,"flags":{},"children":[{"id":565,"name":"MemoizeOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":566,"name":"cache","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A custom "},{"kind":"code","text":"`Map`"},{"kind":"text","text":" instance to store cached values. Can also be used to pre-cache expected values."}]},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L17"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":560,"typeArguments":[{"type":"reference","target":569,"name":"T","package":"@boost/decorators","qualifiedName":"MemoizeOptions.T","refersToTypeParameter":true}],"name":"MemoizeCache","package":"@boost/decorators"}]}},{"id":567,"name":"expires","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Time in milliseconds in which to keep the cache alive (TTL).\\nPass "},{"kind":"code","text":"`0`"},{"kind":"text","text":" to cache indefinitely. Defaults to "},{"kind":"code","text":"`0`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L22"}],"type":{"type":"intrinsic","name":"number"}},{"id":568,"name":"hasher","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A hashing function to determine the cache key. Is passed the method\'s arguments\\nand must return a string. If not provided, arguments are hashed using "},{"kind":"code","text":"`JSON.stringify()`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L27"}],"type":{"type":"reference","target":556,"name":"MemoizeHasher","package":"@boost/decorators"}}],"groups":[{"title":"Properties","children":[566,567,568]}],"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":15,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L15"}],"typeParameters":[{"id":569,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/decorators/interface/MemoizeOptions","previousId":570,"nextId":560},{"id":560,"name":"MemoizeCache","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":7,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L7"}],"typeParameters":[{"id":564,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reflection","declaration":{"id":561,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":562,"name":"time","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":10,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L10"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"literal","value":null}]}},{"id":563,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":11,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L11"}],"type":{"type":"reference","target":564,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[562,563]}],"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L9"}]}}],"name":"Map","package":"typescript"},"permalink":"/api/decorators#MemoizeCache","previousId":565,"nextId":556},{"id":556,"name":"MemoizeHasher","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L5"}],"type":{"type":"reflection","declaration":{"id":557,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":5,"character":28,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L5"}],"signatures":[{"id":558,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":559,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"string"}}]}},"permalink":"/api/decorators#MemoizeHasher","previousId":560,"nextId":551},{"id":551,"name":"MemoizedFunction","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L3"}],"typeParameters":[{"id":555,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":552,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":3,"character":34,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L3"}],"signatures":[{"id":553,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":554,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"reference","target":555,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}}]}},"permalink":"/api/decorators#MemoizedFunction","previousId":556},{"id":534,"name":"Bind","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Bind.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Bind.ts#L7"}],"signatures":[{"id":535,"name":"Bind","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that automatically binds a class method\'s\\n"},{"kind":"code","text":"`this`"},{"kind":"text","text":" context to its current instance."}]},"sources":[{"fileName":"packages/decorators/src/Bind.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Bind.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/decorators/function/Bind","nextId":536},{"id":536,"name":"Debounce","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Debounce.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Debounce.ts#L7"}],"signatures":[{"id":537,"name":"Debounce","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that delays the execution of the class method\\nby the provided time in milliseconds."}]},"sources":[{"fileName":"packages/decorators/src/Debounce.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Debounce.ts#L7"}],"parameters":[{"id":538,"name":"delay","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/decorators/function/Debounce","previousId":534,"nextId":539},{"id":539,"name":"Deprecate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Deprecate.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Deprecate.ts#L13"}],"signatures":[{"id":540,"name":"Deprecate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A decorator that marks a class declaration, class method,\\nclass property, or method parameter as deprecated by\\nlogging a deprecation message to the console."}]},"sources":[{"fileName":"packages/decorators/src/Deprecate.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Deprecate.ts#L13"}],"parameters":[{"id":541,"name":"message","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reflection","declaration":{"id":542,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/src/Deprecate.ts","line":14,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Deprecate.ts#L14"}],"signatures":[{"id":543,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/decorators/src/Deprecate.ts","line":14,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Deprecate.ts#L14"}],"parameters":[{"id":544,"name":"target","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Object"},"name":"Object","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Function"},"name":"Function","package":"typescript"}]}},{"id":545,"name":"property","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"symbol"}]}},{"id":546,"name":"descriptor","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"permalink":"/api/decorators/function/Deprecate","previousId":536,"nextId":547},{"id":547,"name":"Memoize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L80"}],"signatures":[{"id":548,"name":"Memoize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that caches the return value of a class method or\\ngetter to consistently and efficiently return the same value."}]},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L80"}],"typeParameter":[{"id":549,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":550,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":556,"name":"MemoizeHasher","package":"@boost/decorators"},{"type":"reference","target":565,"typeArguments":[{"type":"reference","target":549,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}],"name":"MemoizeOptions","package":"@boost/decorators"}]},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/decorators/function/Memoize","previousId":539,"nextId":570},{"id":570,"name":"Throttle","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Throttle.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Throttle.ts#L7"}],"signatures":[{"id":571,"name":"Throttle","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that throttles the execution of a class method to\\nonly fire once within every delay timeframe (in milliseconds)."}]},"sources":[{"fileName":"packages/decorators/src/Throttle.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Throttle.ts#L7"}],"parameters":[{"id":572,"name":"delay","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/decorators/function/Throttle","previousId":547,"nextId":565}],"groups":[{"title":"Functions","children":[534,536,539,547,570]},{"title":"Interfaces","children":[565]},{"title":"Type Aliases","children":[560,556,551]}],"sources":[{"fileName":"packages/decorators/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/index.ts#L1"}],"permalink":"/api/decorators"},"urlSlug":"decorators"}],"packageName":"@boost/decorators","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":4,"name":"@boost/event","variant":"declaration","kind":2,"flags":{},"children":[{"id":573,"name":"BailEvent","variant":"declaration","kind":128,"flags":{},"children":[{"id":574,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":575,"name":"new BailEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":576,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":577,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":578,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":573,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}],"name":"BailEvent","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":618,"name":"BaseEvent.constructor"}}],"inheritedFrom":{"type":"reference","target":617,"name":"BaseEvent.constructor"}},{"id":583,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true},{"type":"literal","value":"*"}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":623,"name":"BaseEvent.listeners"}},{"id":584,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":624,"name":"BaseEvent.name"}},{"id":585,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":586,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":587,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":626,"name":"BaseEvent.clearListeners"}}],"inheritedFrom":{"type":"reference","target":625,"name":"BaseEvent.clearListeners"}},{"id":579,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BailEvent.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BailEvent.ts#L14"}],"signatures":[{"id":580,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Synchronously execute listeners with the defined arguments.\\nIf a listener returns "},{"kind":"code","text":"`false`"},{"kind":"text","text":", the loop with be aborted early,\\nand the emitter will return "},{"kind":"code","text":"`true`"},{"kind":"text","text":" (for bailed)."}]},"sources":[{"fileName":"packages/event/src/BailEvent.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BailEvent.ts#L14"}],"parameters":[{"id":581,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true}},{"id":582,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","target":655,"name":"BaseEvent.emit"}}],"overwrites":{"type":"reference","target":654,"name":"BaseEvent.emit"}},{"id":588,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":589,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":590,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"},"inheritedFrom":{"type":"reference","target":629,"name":"BaseEvent.getListeners"}}],"inheritedFrom":{"type":"reference","target":628,"name":"BaseEvent.getListeners"}},{"id":591,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":592,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true},{"type":"literal","value":"*"}]}},"inheritedFrom":{"type":"reference","target":632,"name":"BaseEvent.getScopes"}}],"inheritedFrom":{"type":"reference","target":631,"name":"BaseEvent.getScopes"}},{"id":593,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":594,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":595,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}},{"id":596,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":634,"name":"BaseEvent.listen"}}],"inheritedFrom":{"type":"reference","target":633,"name":"BaseEvent.listen"}},{"id":597,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":598,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":599,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}},{"id":600,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":638,"name":"BaseEvent.once"}}],"inheritedFrom":{"type":"reference","target":637,"name":"BaseEvent.once"}},{"id":601,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":602,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":603,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}},{"id":604,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":642,"name":"BaseEvent.unlisten"}}],"inheritedFrom":{"type":"reference","target":641,"name":"BaseEvent.unlisten"}}],"groups":[{"title":"Constructors","children":[574]},{"title":"Properties","children":[583,584]},{"title":"Methods","children":[585,579,588,591,593,597,601]}],"sources":[{"fileName":"packages/event/src/BailEvent.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BailEvent.ts#L4"}],"typeParameters":[{"id":614,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":615,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedTypes":[{"type":"reference","target":616,"typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]},{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}],"permalink":"/api/event/class/BailEvent","nextId":616},{"id":616,"name":"BaseEvent","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":617,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":618,"name":"new BaseEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":619,"name":"Return","variant":"typeParam","kind":131072,"flags":{}},{"id":620,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":621,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":622,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":616,"typeArguments":[{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true},{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}}]},{"id":623,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true},{"type":"literal","value":"*"}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"..."},{"id":624,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"}},{"id":625,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":626,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":627,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":654,"name":"emit","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":123,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L123"}],"signatures":[{"id":655,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Emit the event by executing all scoped listeners with the defined arguments."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":123,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L123"}],"parameters":[{"id":656,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":657,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"unknown"}}]},{"id":628,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":629,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":630,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}}]},{"id":631,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":632,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true},{"type":"literal","value":"*"}]}}}]},{"id":633,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":634,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":635,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}},{"id":636,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"}}]},{"id":637,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":638,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":639,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}},{"id":640,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"}}]},{"id":641,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":642,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":643,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}},{"id":644,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[617]},{"title":"Properties","children":[623,624]},{"title":"Methods","children":[625,654,628,631,633,637,641]}],"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":6,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L6"}],"typeParameters":[{"id":658,"name":"Return","variant":"typeParam","kind":131072,"flags":{}},{"id":659,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":660,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedBy":[{"type":"reference","target":573,"name":"BailEvent"},{"type":"reference","target":661,"name":"ConcurrentEvent"},{"type":"reference","target":706,"name":"Event"},{"type":"reference","target":790,"name":"WaterfallEvent"}],"permalink":"/api/event/class/BaseEvent","previousId":573,"nextId":661},{"id":661,"name":"ConcurrentEvent","variant":"declaration","kind":128,"flags":{},"children":[{"id":662,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":663,"name":"new ConcurrentEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":664,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":665,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":666,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":661,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}],"name":"ConcurrentEvent","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":618,"name":"BaseEvent.constructor"}}],"inheritedFrom":{"type":"reference","target":617,"name":"BaseEvent.constructor"}},{"id":671,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":623,"name":"BaseEvent.listeners"}},{"id":672,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":624,"name":"BaseEvent.name"}},{"id":673,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":674,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":675,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":626,"name":"BaseEvent.clearListeners"}}],"inheritedFrom":{"type":"reference","target":625,"name":"BaseEvent.clearListeners"}},{"id":667,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/ConcurrentEvent.ts","line":12,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/ConcurrentEvent.ts#L12"}],"signatures":[{"id":668,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Asynchronously execute listeners for with the defined arguments.\\nWill return a promise with an array of each listener result."}]},"sources":[{"fileName":"packages/event/src/ConcurrentEvent.ts","line":12,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/ConcurrentEvent.ts#L12"}],"parameters":[{"id":669,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true}},{"id":670,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":655,"name":"BaseEvent.emit"}}],"overwrites":{"type":"reference","target":654,"name":"BaseEvent.emit"}},{"id":676,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":677,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":678,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"},"inheritedFrom":{"type":"reference","target":629,"name":"BaseEvent.getListeners"}}],"inheritedFrom":{"type":"reference","target":628,"name":"BaseEvent.getListeners"}},{"id":679,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":680,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}]}},"inheritedFrom":{"type":"reference","target":632,"name":"BaseEvent.getScopes"}}],"inheritedFrom":{"type":"reference","target":631,"name":"BaseEvent.getScopes"}},{"id":681,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":682,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":683,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}},{"id":684,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":634,"name":"BaseEvent.listen"}}],"inheritedFrom":{"type":"reference","target":633,"name":"BaseEvent.listen"}},{"id":685,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":686,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":687,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}},{"id":688,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":638,"name":"BaseEvent.once"}}],"inheritedFrom":{"type":"reference","target":637,"name":"BaseEvent.once"}},{"id":689,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":690,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":691,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}},{"id":692,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":642,"name":"BaseEvent.unlisten"}}],"inheritedFrom":{"type":"reference","target":641,"name":"BaseEvent.unlisten"}}],"groups":[{"title":"Constructors","children":[662]},{"title":"Properties","children":[671,672]},{"title":"Methods","children":[673,667,676,679,681,685,689]}],"sources":[{"fileName":"packages/event/src/ConcurrentEvent.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/ConcurrentEvent.ts#L4"}],"typeParameters":[{"id":702,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":703,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedTypes":[{"type":"reference","target":616,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"},{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}],"permalink":"/api/event/class/ConcurrentEvent","previousId":616,"nextId":706},{"id":706,"name":"Event","variant":"declaration","kind":128,"flags":{},"children":[{"id":707,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":708,"name":"new Event","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":709,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":710,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":711,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":706,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}],"name":"Event","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":618,"name":"BaseEvent.constructor"}}],"inheritedFrom":{"type":"reference","target":617,"name":"BaseEvent.constructor"}},{"id":716,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":623,"name":"BaseEvent.listeners"}},{"id":717,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":624,"name":"BaseEvent.name"}},{"id":718,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":719,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":720,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":626,"name":"BaseEvent.clearListeners"}}],"inheritedFrom":{"type":"reference","target":625,"name":"BaseEvent.clearListeners"}},{"id":712,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/Event.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/Event.ts#L11"}],"signatures":[{"id":713,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Synchronously execute listeners with the defined arguments."}]},"sources":[{"fileName":"packages/event/src/Event.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/Event.ts#L11"}],"parameters":[{"id":714,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true}},{"id":715,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","target":655,"name":"BaseEvent.emit"}}],"overwrites":{"type":"reference","target":654,"name":"BaseEvent.emit"}},{"id":721,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":722,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":723,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"},"inheritedFrom":{"type":"reference","target":629,"name":"BaseEvent.getListeners"}}],"inheritedFrom":{"type":"reference","target":628,"name":"BaseEvent.getListeners"}},{"id":724,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":725,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}]}},"inheritedFrom":{"type":"reference","target":632,"name":"BaseEvent.getScopes"}}],"inheritedFrom":{"type":"reference","target":631,"name":"BaseEvent.getScopes"}},{"id":726,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":727,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":728,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}},{"id":729,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":634,"name":"BaseEvent.listen"}}],"inheritedFrom":{"type":"reference","target":633,"name":"BaseEvent.listen"}},{"id":730,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":731,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":732,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}},{"id":733,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":638,"name":"BaseEvent.once"}}],"inheritedFrom":{"type":"reference","target":637,"name":"BaseEvent.once"}},{"id":734,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":735,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":736,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}},{"id":737,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":642,"name":"BaseEvent.unlisten"}}],"inheritedFrom":{"type":"reference","target":641,"name":"BaseEvent.unlisten"}}],"groups":[{"title":"Constructors","children":[707]},{"title":"Properties","children":[716,717]},{"title":"Methods","children":[718,712,721,724,726,730,734]}],"sources":[{"fileName":"packages/event/src/Event.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/Event.ts#L3"}],"typeParameters":[{"id":747,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":748,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedTypes":[{"type":"reference","target":616,"typeArguments":[{"type":"intrinsic","name":"void"},{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}],"permalink":"/api/event/class/Event","previousId":661,"nextId":790},{"id":790,"name":"WaterfallEvent","variant":"declaration","kind":128,"flags":{},"children":[{"id":791,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":792,"name":"new WaterfallEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":793,"name":"Arg","variant":"typeParam","kind":131072,"flags":{}},{"id":794,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":795,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":790,"typeArguments":[{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true},{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}],"name":"WaterfallEvent","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":618,"name":"BaseEvent.constructor"}}],"inheritedFrom":{"type":"reference","target":617,"name":"BaseEvent.constructor"}},{"id":800,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reflection","declaration":{"id":801,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":802,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":803,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":623,"name":"BaseEvent.listeners"}},{"id":804,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":624,"name":"BaseEvent.name"}},{"id":805,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":806,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":807,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":626,"name":"BaseEvent.clearListeners"}}],"inheritedFrom":{"type":"reference","target":625,"name":"BaseEvent.clearListeners"}},{"id":796,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/WaterfallEvent.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/WaterfallEvent.ts#L13"}],"signatures":[{"id":797,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Synchronously execute listeners with the defined argument value.\\nThe return value of each listener will be passed as an argument to the next listener."}]},"sources":[{"fileName":"packages/event/src/WaterfallEvent.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/WaterfallEvent.ts#L13"}],"parameters":[{"id":798,"name":"arg","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}},{"id":799,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true},"overwrites":{"type":"reference","target":655,"name":"BaseEvent.emit"}}],"overwrites":{"type":"reference","target":654,"name":"BaseEvent.emit"}},{"id":808,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":809,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":810,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reflection","declaration":{"id":811,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":812,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":813,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}],"name":"Set","package":"typescript"},"inheritedFrom":{"type":"reference","target":629,"name":"BaseEvent.getListeners"}}],"inheritedFrom":{"type":"reference","target":628,"name":"BaseEvent.getListeners"}},{"id":814,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":815,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}]}},"inheritedFrom":{"type":"reference","target":632,"name":"BaseEvent.getScopes"}}],"inheritedFrom":{"type":"reference","target":631,"name":"BaseEvent.getScopes"}},{"id":816,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":817,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":818,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":819,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":820,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":821,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}},{"id":822,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":634,"name":"BaseEvent.listen"}}],"inheritedFrom":{"type":"reference","target":633,"name":"BaseEvent.listen"}},{"id":823,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":824,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":825,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":826,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":827,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":828,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}},{"id":829,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":638,"name":"BaseEvent.once"}}],"inheritedFrom":{"type":"reference","target":637,"name":"BaseEvent.once"}},{"id":830,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":831,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":832,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":833,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":834,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":835,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}},{"id":836,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":642,"name":"BaseEvent.unlisten"}}],"inheritedFrom":{"type":"reference","target":641,"name":"BaseEvent.unlisten"}}],"groups":[{"title":"Constructors","children":[791]},{"title":"Properties","children":[800,804]},{"title":"Methods","children":[805,796,808,814,816,823,830]}],"sources":[{"fileName":"packages/event/src/WaterfallEvent.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/WaterfallEvent.ts#L4"}],"typeParameters":[{"id":846,"name":"Arg","variant":"typeParam","kind":131072,"flags":{}},{"id":847,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedTypes":[{"type":"reference","target":616,"typeArguments":[{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true},{"type":"tuple","elements":[{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}]},{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}],"permalink":"/api/event/class/WaterfallEvent","previousId":706,"nextId":749},{"id":749,"name":"EventErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/event/src/EventError.ts","line":9,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/EventError.ts#L9"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/event/src/EventError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/event","preferValues":true}}},"permalink":"/api/event#EventErrorCode","previousId":790,"nextId":755},{"id":755,"name":"Listener","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":1,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L1"}],"typeParameters":[{"id":784,"name":"A","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":785,"name":"R","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"},{"type":"inferred","name":"A2"},{"type":"inferred","name":"A3"},{"type":"inferred","name":"A4"},{"type":"inferred","name":"A5"}]},"trueType":{"type":"reflection","declaration":{"id":756,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":8,"character":3,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L8"}],"signatures":[{"id":757,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":758,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}},{"id":759,"name":"a2","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A2"},"name":"A2","package":"@boost/event","refersToTypeParameter":true}},{"id":760,"name":"a3","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A3"},"name":"A3","package":"@boost/event","refersToTypeParameter":true}},{"id":761,"name":"a4","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A4"},"name":"A4","package":"@boost/event","refersToTypeParameter":true}},{"id":762,"name":"a5","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A5"},"name":"A5","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"},{"type":"inferred","name":"A2"},{"type":"inferred","name":"A3"},{"type":"inferred","name":"A4"}]},"trueType":{"type":"reflection","declaration":{"id":763,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":10,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L10"}],"signatures":[{"id":764,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":765,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}},{"id":766,"name":"a2","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A2"},"name":"A2","package":"@boost/event","refersToTypeParameter":true}},{"id":767,"name":"a3","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A3"},"name":"A3","package":"@boost/event","refersToTypeParameter":true}},{"id":768,"name":"a4","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A4"},"name":"A4","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"},{"type":"inferred","name":"A2"},{"type":"inferred","name":"A3"}]},"trueType":{"type":"reflection","declaration":{"id":769,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":12,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L12"}],"signatures":[{"id":770,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":771,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}},{"id":772,"name":"a2","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A2"},"name":"A2","package":"@boost/event","refersToTypeParameter":true}},{"id":773,"name":"a3","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A3"},"name":"A3","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"},{"type":"inferred","name":"A2"}]},"trueType":{"type":"reflection","declaration":{"id":774,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":14,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L14"}],"signatures":[{"id":775,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":776,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}},{"id":777,"name":"a2","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A2"},"name":"A2","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"}]},"trueType":{"type":"reflection","declaration":{"id":778,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":779,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":780,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},"trueType":{"type":"reflection","declaration":{"id":781,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":18,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L18"}],"signatures":[{"id":782,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":783,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"intrinsic","name":"never"}}}}}}},"permalink":"/api/event#Listener","previousId":749,"nextId":786},{"id":786,"name":"Unlistener","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":21,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L21"}],"type":{"type":"reflection","declaration":{"id":787,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":21,"character":25,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L21"}],"signatures":[{"id":788,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"void"}}]}},"permalink":"/api/event#Unlistener","previousId":755,"nextId":789},{"id":789,"name":"WildstarScope","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":23,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L23"}],"type":{"type":"literal","value":"*"},"permalink":"/api/event#WildstarScope","previousId":786,"nextId":705},{"id":705,"name":"EVENT_NAME_PATTERN","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/event/src/constants.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/constants.ts#L3"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/event#EVENT_NAME_PATTERN","previousId":789,"nextId":750},{"id":750,"name":"EventError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/event/src/EventError.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/EventError.ts#L11"}],"type":{"type":"reflection","declaration":{"id":751,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":752,"name":"new EventError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":753,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"LISTENER_INVALID"},{"type":"literal","value":"NAME_INVALID"}]}},{"id":754,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"LISTENER_INVALID"},{"type":"literal","value":"NAME_INVALID"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/event#EventError","previousId":705,"nextId":704},{"id":704,"name":"WILDCARD_SCOPE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/event/src/constants.ts","line":1,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/constants.ts#L1"}],"type":{"type":"literal","value":"*"},"defaultValue":"\'*\'","permalink":"/api/event#WILDCARD_SCOPE","previousId":750}],"groups":[{"title":"Classes","children":[573,616,661,706,790]},{"title":"Type Aliases","children":[749,755,786,789]},{"title":"Variables","children":[705,750,704]}],"sources":[{"fileName":"packages/event/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/index.ts#L1"}],"permalink":"/api/event"},"urlSlug":"event"}],"packageName":"@boost/event","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":95,"name":"@boost/log","variant":"declaration","kind":2,"flags":{},"children":[{"id":3210,"name":"formats","variant":"declaration","kind":4,"flags":{},"children":[{"id":3211,"name":"console","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/formats.ts","line":18,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L18"}],"signatures":[{"id":3212,"name":"console","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the item as if it\'s being logged to "},{"kind":"code","text":"`console`"},{"kind":"text","text":".\\n_Only_ inclues the label and message."}]},"sources":[{"fileName":"packages/log/src/formats.ts","line":18,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L18"}],"parameters":[{"id":3213,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/log/namespace/formats#console"},{"id":3214,"name":"debug","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/formats.ts","line":32,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L32"}],"signatures":[{"id":3215,"name":"debug","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the item into a human-readable message with all item fields included.\\nThis is the default format for most transports."}]},"sources":[{"fileName":"packages/log/src/formats.ts","line":32,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L32"}],"parameters":[{"id":3216,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/log/namespace/formats#debug"},{"id":3217,"name":"json","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/formats.ts","line":46,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L46"}],"signatures":[{"id":3218,"name":"json","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the entire item into JSON."}]},"sources":[{"fileName":"packages/log/src/formats.ts","line":46,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L46"}],"parameters":[{"id":3219,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/log/namespace/formats#json"},{"id":3220,"name":"message","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/formats.ts","line":53,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L53"}],"signatures":[{"id":3221,"name":"message","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the item using _only_ the message."}]},"sources":[{"fileName":"packages/log/src/formats.ts","line":53,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L53"}],"parameters":[{"id":3222,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/log/namespace/formats#message"}],"groups":[{"title":"Functions","children":[3211,3214,3217,3220]}],"sources":[{"fileName":"packages/log/src/formats.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L1"}],"permalink":"/api/log/namespace/formats","previousId":3510,"nextId":3515},{"id":3279,"name":"ConsoleTransport","variant":"declaration","kind":128,"flags":{},"children":[{"id":3280,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L7"}],"signatures":[{"id":3281,"name":"new ConsoleTransport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L7"}],"parameters":[{"id":3282,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}],"type":{"type":"reference","target":3279,"name":"ConsoleTransport","package":"@boost/log"},"overwrites":{"type":"reference","target":3257,"name":"Transport.constructor"}}],"overwrites":{"type":"reference","target":3256,"name":"Transport.constructor"}},{"id":3287,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","inheritedFrom":{"type":"reference","target":3260,"name":"Transport.levels"}},{"id":3294,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3271,"name":"Transport.options"}},{"id":3288,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L20"}],"signatures":[{"id":3289,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L20"}],"parameters":[{"id":3290,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"inheritedFrom":{"type":"reference","target":3262,"name":"Transport.blueprint"}}],"inheritedFrom":{"type":"reference","target":3261,"name":"Transport.blueprint"}},{"id":3295,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3296,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3297,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3298,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3299,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3300,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3273,"name":"Transport.configure"}}],"inheritedFrom":{"type":"reference","target":3272,"name":"Transport.configure"}},{"id":3291,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3292,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3293,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3265,"name":"Transport.format"}}],"inheritedFrom":{"type":"reference","target":3264,"name":"Transport.format"}},{"id":3283,"name":"write","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L15"}],"signatures":[{"id":3284,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write the formatted message according to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L15"}],"parameters":[{"id":3285,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3286,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","target":3268,"name":"Transport.write"}}],"overwrites":{"type":"reference","target":3267,"name":"Transport.write"}}],"groups":[{"title":"Constructors","children":[3280]},{"title":"Properties","children":[3287,3294]},{"title":"Methods","children":[3288,3295,3291,3283]}],"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L6"}],"extendedTypes":[{"type":"reference","target":3255,"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Transport","package":"@boost/log"}],"permalink":"/api/log/class/ConsoleTransport","nextId":3308},{"id":3308,"name":"FileTransport","variant":"declaration","kind":128,"flags":{},"children":[{"id":3309,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L36"}],"signatures":[{"id":3310,"name":"new FileTransport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L36"}],"typeParameter":[{"id":3311,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"},"default":{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"}}],"parameters":[{"id":3312,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":3308,"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"FileTransport","package":"@boost/log"},"overwrites":{"type":"reference","target":3257,"name":"Transport.constructor"}}],"overwrites":{"type":"reference","target":3256,"name":"Transport.constructor"}},{"id":3347,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","inheritedFrom":{"type":"reference","target":3260,"name":"Transport.levels"}},{"id":3351,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3271,"name":"Transport.options"}},{"id":3313,"name":"path","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":24,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L24"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"}},{"id":3314,"name":"stream","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L26"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeJS.WritableStream"},"name":"WritableStream","package":"@types/node","qualifiedName":"__global.NodeJS.WritableStream"}},{"id":3319,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":44,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L44"}],"signatures":[{"id":3320,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":44,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L44"}],"parameters":[{"id":3321,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":3262,"name":"Transport.blueprint"}}],"overwrites":{"type":"reference","target":3261,"name":"Transport.blueprint"}},{"id":3322,"name":"close","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"signatures":[{"id":3323,"name":"close","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Close the file stream and trigger the callback when finished."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"parameters":[{"id":3324,"name":"commit","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":3325,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"signatures":[{"id":3326,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":3352,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3353,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3354,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3355,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3356,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3357,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3273,"name":"Transport.configure"}}],"inheritedFrom":{"type":"reference","target":3272,"name":"Transport.configure"}},{"id":3348,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3349,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3350,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3265,"name":"Transport.format"}}],"inheritedFrom":{"type":"reference","target":3264,"name":"Transport.format"}},{"id":3327,"name":"open","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L74"}],"signatures":[{"id":3328,"name":"open","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Open the file stream for writing."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L74"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeJS.WritableStream"},"name":"WritableStream","package":"@types/node","qualifiedName":"__global.NodeJS.WritableStream"}}]},{"id":3329,"name":"write","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L98"}],"signatures":[{"id":3330,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the file stream, and rotate files once written if necessary."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L98"}],"parameters":[{"id":3331,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","target":3268,"name":"Transport.write"}}],"overwrites":{"type":"reference","target":3267,"name":"Transport.write"}}],"groups":[{"title":"Constructors","children":[3309]},{"title":"Properties","children":[3347,3351,3313,3314]},{"title":"Methods","children":[3319,3322,3352,3348,3327,3329]}],"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":21,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L21"}],"typeParameters":[{"id":3358,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"},"default":{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"}}],"extendedTypes":[{"type":"reference","target":3255,"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Transport","package":"@boost/log"}],"extendedBy":[{"type":"reference","target":3367,"name":"RotatingFileTransport"}],"permalink":"/api/log/class/FileTransport","previousId":3279,"nextId":3229},{"id":3229,"name":"Logger","variant":"declaration","kind":128,"flags":{},"children":[{"id":3230,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L15"}],"signatures":[{"id":3231,"name":"new Logger","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L15"}],"parameters":[{"id":3232,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}}],"type":{"type":"reference","target":3229,"name":"Logger","package":"@boost/log"},"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":3248,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":3234,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L29"}],"signatures":[{"id":3235,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L29"}],"parameters":[{"id":3236,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":3249,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3250,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3251,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3252,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3253,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3254,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":3237,"name":"disable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L45"}],"signatures":[{"id":3238,"name":"disable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/Logger.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L45"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":3239,"name":"enable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L53"}],"signatures":[{"id":3240,"name":"enable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/Logger.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L53"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":3241,"name":"isAllowed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L58"}],"signatures":[{"id":3242,"name":"isAllowed","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L58"}],"parameters":[{"id":3243,"name":"level","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},{"id":3244,"name":"maxLevel","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":3245,"name":"log","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L76"}],"signatures":[{"id":3246,"name":"log","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L76"}],"parameters":[{"id":3247,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3459,"name":"LogOptions","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Constructors","children":[3230]},{"title":"Properties","children":[3248]},{"title":"Methods","children":[3234,3249,3237,3239,3241,3245]}],"sources":[{"fileName":"packages/log/src/Logger.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L12"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Contract","package":"@boost/common"}],"permalink":"/api/log/class/Logger","previousId":3308,"nextId":3367},{"id":3367,"name":"RotatingFileTransport","variant":"declaration","kind":128,"flags":{},"children":[{"id":3368,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L36"}],"signatures":[{"id":3369,"name":"new RotatingFileTransport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L36"}],"parameters":[{"id":3370,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}}],"type":{"type":"reference","target":3367,"name":"RotatingFileTransport","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3310,"name":"FileTransport.constructor"}}],"inheritedFrom":{"type":"reference","target":3309,"name":"FileTransport.constructor"}},{"id":3409,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","inheritedFrom":{"type":"reference","target":3347,"name":"FileTransport.levels"}},{"id":3413,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3351,"name":"FileTransport.options"}},{"id":3384,"name":"path","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":24,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L24"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":3313,"name":"FileTransport.path"}},{"id":3385,"name":"stream","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L26"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeJS.WritableStream"},"name":"WritableStream","package":"@types/node","qualifiedName":"__global.NodeJS.WritableStream"},"inheritedFrom":{"type":"reference","target":3314,"name":"FileTransport.stream"}},{"id":3372,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":15,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L15"}],"signatures":[{"id":3373,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":15,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L15"}],"parameters":[{"id":3374,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":3320,"name":"FileTransport.blueprint"}}],"overwrites":{"type":"reference","target":3319,"name":"FileTransport.blueprint"}},{"id":3390,"name":"close","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"signatures":[{"id":3391,"name":"close","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Close the file stream and trigger the callback when finished."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"parameters":[{"id":3392,"name":"commit","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":3393,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"signatures":[{"id":3394,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","target":3323,"name":"FileTransport.close"}}],"inheritedFrom":{"type":"reference","target":3322,"name":"FileTransport.close"}},{"id":3414,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3415,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3416,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3417,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3418,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3419,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3353,"name":"FileTransport.configure"}}],"inheritedFrom":{"type":"reference","target":3352,"name":"FileTransport.configure"}},{"id":3410,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3411,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3412,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3349,"name":"FileTransport.format"}}],"inheritedFrom":{"type":"reference","target":3348,"name":"FileTransport.format"}},{"id":3375,"name":"formatTimestamp","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L27"}],"signatures":[{"id":3376,"name":"formatTimestamp","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format a "},{"kind":"code","text":"`Date`"},{"kind":"text","text":" object into a format used within the log file name."}]},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L27"}],"parameters":[{"id":3377,"name":"ms","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}]},{"id":3395,"name":"open","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L74"}],"signatures":[{"id":3396,"name":"open","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Open the file stream for writing."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L74"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeJS.WritableStream"},"name":"WritableStream","package":"@types/node","qualifiedName":"__global.NodeJS.WritableStream"},"inheritedFrom":{"type":"reference","target":3328,"name":"FileTransport.open"}}],"inheritedFrom":{"type":"reference","target":3327,"name":"FileTransport.open"}},{"id":3397,"name":"write","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L98"}],"signatures":[{"id":3398,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the file stream, and rotate files once written if necessary."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L98"}],"parameters":[{"id":3399,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","target":3330,"name":"FileTransport.write"}}],"inheritedFrom":{"type":"reference","target":3329,"name":"FileTransport.write"}}],"groups":[{"title":"Constructors","children":[3368]},{"title":"Properties","children":[3409,3413,3384,3385]},{"title":"Methods","children":[3372,3390,3414,3410,3375,3395,3397]}],"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L12"}],"extendedTypes":[{"type":"reference","target":3308,"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"FileTransport","package":"@boost/log"}],"permalink":"/api/log/class/RotatingFileTransport","previousId":3229,"nextId":3425},{"id":3425,"name":"StreamTransport","variant":"declaration","kind":128,"flags":{},"children":[{"id":3426,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L13"}],"signatures":[{"id":3427,"name":"new StreamTransport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L13"}],"parameters":[{"id":3428,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}}],"type":{"type":"reference","target":3425,"name":"StreamTransport","package":"@boost/log"},"overwrites":{"type":"reference","target":3257,"name":"Transport.constructor"}}],"overwrites":{"type":"reference","target":3256,"name":"Transport.constructor"}},{"id":3436,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","inheritedFrom":{"type":"reference","target":3260,"name":"Transport.levels"}},{"id":3440,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3271,"name":"Transport.options"}},{"id":3430,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L19"}],"signatures":[{"id":3431,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L19"}],"parameters":[{"id":3432,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":3262,"name":"Transport.blueprint"}}],"overwrites":{"type":"reference","target":3261,"name":"Transport.blueprint"}},{"id":3441,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3442,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3443,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3444,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3445,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3446,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3273,"name":"Transport.configure"}}],"inheritedFrom":{"type":"reference","target":3272,"name":"Transport.configure"}},{"id":3437,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3438,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3439,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3265,"name":"Transport.format"}}],"inheritedFrom":{"type":"reference","target":3264,"name":"Transport.format"}},{"id":3433,"name":"write","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L33"}],"signatures":[{"id":3434,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the configured stream."}]},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L33"}],"parameters":[{"id":3435,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","target":3268,"name":"Transport.write"}}],"overwrites":{"type":"reference","target":3267,"name":"Transport.write"}}],"groups":[{"title":"Constructors","children":[3426]},{"title":"Properties","children":[3436,3440]},{"title":"Methods","children":[3430,3441,3437,3433]}],"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L10"}],"extendedTypes":[{"type":"reference","target":3255,"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Transport","package":"@boost/log"}],"permalink":"/api/log/class/StreamTransport","previousId":3367,"nextId":3255},{"id":3255,"name":"Transport","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":3256,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L14"}],"signatures":[{"id":3257,"name":"new Transport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L14"}],"typeParameter":[{"id":3258,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}}],"parameters":[{"id":3259,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":3255,"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Transport","package":"@boost/log"},"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":3260,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","implementationOf":{"type":"reference","target":3520,"name":"Transportable.levels"}},{"id":3271,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":3261,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L20"}],"signatures":[{"id":3262,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L20"}],"parameters":[{"id":3263,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":3272,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3273,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3274,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3275,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3276,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3277,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":3264,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3265,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3266,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":-1,"name":"Transportable.format"}}],"implementationOf":{"type":"reference","target":3521,"name":"Transportable.format"}},{"id":3267,"name":"write","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L48"}],"signatures":[{"id":3268,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write the formatted message according to the transport."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L48"}],"parameters":[{"id":3269,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3270,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}]},"implementationOf":{"type":"reference","target":3522,"name":"Transportable.write"}}],"implementationOf":{"type":"reference","target":3522,"name":"Transportable.write"}}],"groups":[{"title":"Constructors","children":[3256]},{"title":"Properties","children":[3260,3271]},{"title":"Methods","children":[3261,3272,3264,3267]}],"sources":[{"fileName":"packages/log/src/Transport.ts","line":8,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L8"}],"typeParameters":[{"id":3278,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}],"extendedBy":[{"type":"reference","target":3279,"name":"ConsoleTransport"},{"type":"reference","target":3308,"name":"FileTransport"},{"type":"reference","target":3425,"name":"StreamTransport"}],"implementedTypes":[{"type":"reference","target":3519,"name":"Transportable","package":"@boost/log"}],"permalink":"/api/log/class/Transport","previousId":3425,"nextId":3226},{"id":3301,"name":"FileTransportOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3305,"name":"eol","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"End of line character to append to a message. Defaults to "},{"kind":"code","text":"`os.EOL`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3528,"name":"TransportOptions.eol"}},{"id":3306,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to format a log item into a message string. Default is transport dependent."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":97,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L97"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3529,"name":"TransportOptions.format"}},{"id":3302,"name":"gzip","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Apply gzip compression to the write stream."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L11"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":3307,"name":"levels","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of log levels to only write messages for."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L99"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"inheritedFrom":{"type":"reference","target":3530,"name":"TransportOptions.levels"}},{"id":3303,"name":"maxSize","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Maximum file size before rotating file.\\nWill create a backup and truncate the current file. Defaults to 10mb."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L16"}],"type":{"type":"intrinsic","name":"number"}},{"id":3304,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute file system path for the intended log file."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[3305,3306,3302,3307,3303,3304]}],"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":9,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L9"}],"extendedTypes":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"extendedBy":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions"}],"permalink":"/api/log/interface/FileTransportOptions","previousId":3226,"nextId":3450},{"id":3450,"name":"LogItem","variant":"declaration","kind":256,"flags":{},"children":[{"id":3451,"name":"host","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The name of the host machine."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L9"}],"type":{"type":"intrinsic","name":"string"}},{"id":3452,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The log level as a localized or customized label."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L11"}],"type":{"type":"intrinsic","name":"string"}},{"id":3453,"name":"level","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The log level as a string."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L13"}],"type":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},{"id":3454,"name":"message","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The log message with interpolated arguments applied."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"string"}},{"id":3455,"name":"metadata","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Additional data to include with a log item."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L17"}],"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}},{"id":3456,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of the logger."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L19"}],"type":{"type":"intrinsic","name":"string"}},{"id":3457,"name":"pid","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current process ID."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L21"}],"type":{"type":"intrinsic","name":"number"}},{"id":3458,"name":"time","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Timestamp of the log, native to the host machine."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L23"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Date"},"name":"Date","package":"typescript"}}],"groups":[{"title":"Properties","children":[3451,3452,3453,3454,3455,3456,3457,3458]}],"sources":[{"fileName":"packages/log/src/types.ts","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L7"}],"permalink":"/api/log/interface/LogItem","previousId":3301,"nextId":3459},{"id":3459,"name":"LogOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3460,"name":"args","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Values to interpolate into the message string."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L28"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":3461,"name":"level","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Level to log as."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L30"}],"type":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},{"id":3462,"name":"message","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Message to log to the transports."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L32"}],"type":{"type":"intrinsic","name":"string"}},{"id":3463,"name":"metadata","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Metadata to include in the message item/string."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L34"}],"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}}],"groups":[{"title":"Properties","children":[3460,3461,3462,3463]}],"sources":[{"fileName":"packages/log/src/types.ts","line":26,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L26"}],"permalink":"/api/log/interface/LogOptions","previousId":3450,"nextId":3472},{"id":3472,"name":"Loggable","variant":"declaration","kind":256,"flags":{},"children":[{"id":3473,"name":"debug","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`debug`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":49,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L49"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3474,"name":"disable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"type":{"type":"reflection","declaration":{"id":3475,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"signatures":[{"id":3476,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3477,"name":"enable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"type":{"type":"reflection","declaration":{"id":3478,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"signatures":[{"id":3479,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3480,"name":"error","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`error`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L55"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3482,"name":"info","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`info`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":59,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L59"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3481,"name":"log","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`log`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":57,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L57"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3483,"name":"trace","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`trace`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":61,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L61"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3484,"name":"warn","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`warn`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":63,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L63"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}}],"groups":[{"title":"Properties","children":[3473,3474,3477,3480,3482,3481,3483,3484]}],"sources":[{"fileName":"packages/log/src/types.ts","line":47,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L47"}],"extendedBy":[{"type":"reference","target":3485,"name":"LoggerFunction"}],"permalink":"/api/log/interface/Loggable","previousId":3459,"nextId":3464},{"id":3464,"name":"LoggableWriter","variant":"declaration","kind":256,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":37,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L37"}],"signatures":[{"id":3465,"name":"LoggableWriter","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters,\\nwhile also providing a metadata object to include with the log item."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L42"}],"parameters":[{"id":3466,"name":"metadata","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}},{"id":3467,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3468,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}},{"id":3469,"name":"LoggableWriter","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":44,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L44"}],"parameters":[{"id":3470,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3471,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}}],"extendedBy":[{"type":"reference","target":3485,"name":"LoggerFunction"}],"permalink":"/api/log/interface/LoggableWriter","previousId":3472,"nextId":3485},{"id":3485,"name":"LoggerFunction","variant":"declaration","kind":256,"flags":{},"children":[{"id":3486,"name":"debug","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`debug`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":49,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L49"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3473,"name":"Loggable.debug"}},{"id":3487,"name":"disable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"type":{"type":"reflection","declaration":{"id":3488,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"signatures":[{"id":3489,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":3474,"name":"Loggable.disable"}},{"id":3490,"name":"enable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"type":{"type":"reflection","declaration":{"id":3491,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"signatures":[{"id":3492,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":3477,"name":"Loggable.enable"}},{"id":3493,"name":"error","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`error`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L55"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3480,"name":"Loggable.error"}},{"id":3495,"name":"info","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`info`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":59,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L59"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3482,"name":"Loggable.info"}},{"id":3494,"name":"log","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`log`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":57,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L57"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3481,"name":"Loggable.log"}},{"id":3496,"name":"trace","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`trace`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":61,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L61"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3483,"name":"Loggable.trace"}},{"id":3497,"name":"warn","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`warn`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":63,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L63"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3484,"name":"Loggable.warn"}}],"groups":[{"title":"Properties","children":[3486,3487,3490,3493,3495,3494,3496,3497]}],"sources":[{"fileName":"packages/log/src/types.ts","line":66,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L66"}],"signatures":[{"id":3498,"name":"LoggerFunction","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters,\\nwhile also providing a metadata object to include with the log item."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":66,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L66"}],"parameters":[{"id":3499,"name":"metadata","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}},{"id":3500,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3501,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}},{"id":3502,"name":"LoggerFunction","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":66,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L66"}],"parameters":[{"id":3503,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3504,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}}],"extendedTypes":[{"type":"reference","target":3472,"name":"Loggable","package":"@boost/log"},{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}],"permalink":"/api/log/interface/LoggerFunction","previousId":3464,"nextId":3505},{"id":3505,"name":"LoggerOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3506,"name":"labels","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom labels to use for each log type."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L70"}],"type":{"type":"reference","target":3448,"name":"LogLevelLabels","package":"@boost/log"}},{"id":3507,"name":"metadata","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Metadata to include within each log item."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":72,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L72"}],"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}},{"id":3508,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique name for this logger."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L74"}],"type":{"type":"intrinsic","name":"string"}},{"id":3509,"name":"transports","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of transports to write messages to."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L76"}],"type":{"type":"array","elementType":{"type":"reference","target":3519,"name":"Transportable","package":"@boost/log"}}}],"groups":[{"title":"Properties","children":[3506,3507,3508,3509]}],"sources":[{"fileName":"packages/log/src/types.ts","line":68,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L68"}],"permalink":"/api/log/interface/LoggerOptions","previousId":3485,"nextId":3359},{"id":3359,"name":"RotatingFileTransportOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3364,"name":"eol","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"End of line character to append to a message. Defaults to "},{"kind":"code","text":"`os.EOL`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3305,"name":"FileTransportOptions.eol"}},{"id":3365,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to format a log item into a message string. Default is transport dependent."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":97,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L97"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3306,"name":"FileTransportOptions.format"}},{"id":3361,"name":"gzip","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Apply gzip compression to the write stream."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L11"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":3302,"name":"FileTransportOptions.gzip"}},{"id":3366,"name":"levels","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of log levels to only write messages for."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L99"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"inheritedFrom":{"type":"reference","target":3307,"name":"FileTransportOptions.levels"}},{"id":3362,"name":"maxSize","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Maximum file size before rotating file.\\nWill create a backup and truncate the current file. Defaults to 10mb."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L16"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":3303,"name":"FileTransportOptions.maxSize"}},{"id":3363,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute file system path for the intended log file."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":3304,"name":"FileTransportOptions.path"}},{"id":3360,"name":"rotation","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Period in which to rotate files. Will append a timestamp to the rotated log file."}]},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L9"}],"type":{"type":"reference","target":3531,"name":"Rotation","package":"@boost/log"}}],"groups":[{"title":"Properties","children":[3364,3365,3361,3366,3362,3363,3360]}],"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L7"}],"extendedTypes":[{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"}],"permalink":"/api/log/interface/RotatingFileTransportOptions","previousId":3505,"nextId":3420},{"id":3420,"name":"StreamTransportOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3422,"name":"eol","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"End of line character to append to a message. Defaults to "},{"kind":"code","text":"`os.EOL`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3528,"name":"TransportOptions.eol"}},{"id":3423,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to format a log item into a message string. Default is transport dependent."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":97,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L97"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3529,"name":"TransportOptions.format"}},{"id":3424,"name":"levels","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of log levels to only write messages for."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L99"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"inheritedFrom":{"type":"reference","target":3530,"name":"TransportOptions.levels"}},{"id":3421,"name":"stream","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The stream to pipe messages to."}]},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L7"}],"type":{"type":"reference","target":3510,"name":"Writable","package":"@boost/log"}}],"groups":[{"title":"Properties","children":[3422,3423,3424,3421]}],"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":5,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L5"}],"extendedTypes":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"permalink":"/api/log/interface/StreamTransportOptions","previousId":3359,"nextId":3527},{"id":3527,"name":"TransportOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3528,"name":"eol","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"End of line character to append to a message. Defaults to "},{"kind":"code","text":"`os.EOL`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"string"}},{"id":3529,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to format a log item into a message string. Default is transport dependent."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":97,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L97"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"}},{"id":3530,"name":"levels","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of log levels to only write messages for."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L99"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}}}],"groups":[{"title":"Properties","children":[3528,3529,3530]}],"sources":[{"fileName":"packages/log/src/types.ts","line":93,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L93"}],"extendedBy":[{"type":"reference","target":3301,"name":"FileTransportOptions"},{"type":"reference","target":3420,"name":"StreamTransportOptions"}],"permalink":"/api/log/interface/TransportOptions","previousId":3420,"nextId":3519},{"id":3519,"name":"Transportable","variant":"declaration","kind":256,"flags":{},"children":[{"id":3521,"name":"format","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":88,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L88"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"}},{"id":3520,"name":"levels","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":87,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L87"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}}},{"id":3522,"name":"write","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L90"}],"type":{"type":"reflection","declaration":{"id":3523,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":90,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L90"}],"signatures":[{"id":3524,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":90,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L90"}],"parameters":[{"id":3525,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3526,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}]}}]}}}],"groups":[{"title":"Properties","children":[3521,3520,3522]}],"sources":[{"fileName":"packages/log/src/types.ts","line":86,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L86"}],"implementedBy":[{"type":"reference","target":3255,"name":"Transport"}],"permalink":"/api/log/interface/Transportable","previousId":3527,"nextId":3510},{"id":3510,"name":"Writable","variant":"declaration","kind":256,"flags":{},"children":[{"id":3511,"name":"write","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the configured stream."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L81"}],"type":{"type":"reflection","declaration":{"id":3512,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":81,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L81"}],"signatures":[{"id":3513,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the configured stream."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":81,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L81"}],"parameters":[{"id":3514,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[3511]}],"sources":[{"fileName":"packages/log/src/types.ts","line":79,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L79"}],"permalink":"/api/log/interface/Writable","previousId":3519,"nextId":3210},{"id":3515,"name":"Formatter","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":84,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L84"}],"type":{"type":"reflection","declaration":{"id":3516,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":84,"character":24,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L84"}],"signatures":[{"id":3517,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":3518,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}]}},"permalink":"/api/log#Formatter","previousId":3210,"nextId":3447},{"id":3447,"name":"LogLevel","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":1,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L1"}],"type":{"type":"union","types":[{"type":"literal","value":"debug"},{"type":"literal","value":"error"},{"type":"literal","value":"info"},{"type":"literal","value":"log"},{"type":"literal","value":"trace"},{"type":"literal","value":"warn"}]},"permalink":"/api/log#LogLevel","previousId":3515,"nextId":3448},{"id":3448,"name":"LogLevelLabels","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L3"}],"type":{"type":"mapped","parameter":"L","parameterType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"},"templateType":{"type":"intrinsic","name":"string"},"optionalModifier":"+"},"permalink":"/api/log#LogLevelLabels","previousId":3447,"nextId":3449},{"id":3449,"name":"LogMetadata","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L5"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript"},"permalink":"/api/log#LogMetadata","previousId":3448,"nextId":3531},{"id":3531,"name":"Rotation","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":102,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L102"}],"type":{"type":"union","types":[{"type":"literal","value":"daily"},{"type":"literal","value":"hourly"},{"type":"literal","value":"monthly"},{"type":"literal","value":"weekly"}]},"permalink":"/api/log#Rotation","previousId":3449,"nextId":3224},{"id":3224,"name":"DEFAULT_LABELS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/log/src/constants.ts","line":8,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/constants.ts#L8"}],"type":{"type":"reference","target":3448,"name":"LogLevelLabels","package":"@boost/log"},"defaultValue":"...","permalink":"/api/log#DEFAULT_LABELS","previousId":3531,"nextId":3223},{"id":3223,"name":"LOG_LEVELS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/log/src/constants.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/constants.ts#L6"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"...","permalink":"/api/log#LOG_LEVELS","previousId":3224,"nextId":3225},{"id":3225,"name":"MAX_LOG_SIZE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/log/src/constants.ts","line":17,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/constants.ts#L17"}],"type":{"type":"literal","value":10485760},"defaultValue":"10_485_760","permalink":"/api/log#MAX_LOG_SIZE","previousId":3223},{"id":3226,"name":"createLogger","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/createLogger.ts","line":29,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/createLogger.ts#L29"}],"signatures":[{"id":3227,"name":"createLogger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a logger with any configured transports."}]},"sources":[{"fileName":"packages/log/src/createLogger.ts","line":29,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/createLogger.ts#L29"}],"parameters":[{"id":3228,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}}],"type":{"type":"reference","target":3485,"name":"LoggerFunction","package":"@boost/log"}}],"permalink":"/api/log/function/createLogger","previousId":3255,"nextId":3301}],"groups":[{"title":"Classes","children":[3279,3308,3229,3367,3425,3255]},{"title":"Functions","children":[3226]},{"title":"Interfaces","children":[3301,3450,3459,3472,3464,3485,3505,3359,3420,3527,3519,3510]},{"title":"Namespaces","children":[3210]},{"title":"Type Aliases","children":[3515,3447,3448,3449,3531]},{"title":"Variables","children":[3224,3223,3225]}],"sources":[{"fileName":"packages/log/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/index.ts#L1"}],"permalink":"/api/log"},"urlSlug":"log"},{"index":false,"label":"Test utilities","reflection":{"id":96,"name":"@boost/log/test","variant":"declaration","kind":2,"flags":{},"children":[{"id":97,"name":"mockLogger","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/test.ts","line":18,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/test.ts#L18"}],"signatures":[{"id":98,"name":"mockLogger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a Vitest spy that matches the return value shape of "},{"kind":"code","text":"`createLogger`"},{"kind":"text","text":".\\n\\n"},{"kind":"code","text":"```ts\\nimport { mockLogger } from \'@boost/log/test\';\\n\\nit(\'calls the logger\', async () => {\\n\\tconst log = await mockLogger();\\n\\n\\tlog(\'Something has happened\');\\n\\n\\texpect(log).toHaveBeenCalled();\\n});\\n```"}]},"sources":[{"fileName":"packages/log/src/test.ts","line":18,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/test.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":3485,"name":"LoggerFunction","package":"@boost/log"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/log-test/function/mockLogger"}],"groups":[{"title":"Functions","children":[97]}],"sources":[{"fileName":"packages/log/src/test.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/test.ts#L1"}],"permalink":"/api/log-test"},"urlSlug":"log-test"}],"packageName":"@boost/log","packageVersion":"5.0.0-alpha.3"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":99,"name":"@boost/module","variant":"declaration","kind":2,"flags":{},"children":[{"id":3557,"name":"ModuleLike","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return shape of a module. The default export can be typed with\\nthe "},{"kind":"code","text":"`D`"},{"kind":"text","text":" generic slot, and the named exports can be typed with\\nan object in the "},{"kind":"code","text":"`N`"},{"kind":"text","text":" generic slot.\\n\\nIf there is no default export (classic Node.js "},{"kind":"code","text":"`exports`"},{"kind":"text","text":" pattern),\\nthen "},{"kind":"code","text":"`void`"},{"kind":"text","text":" can be passed to the "},{"kind":"code","text":"`D`"},{"kind":"text","text":" generic, which will populate\\nthe "},{"kind":"code","text":"`default`"},{"kind":"text","text":" property with the named exports."}]},"sources":[{"fileName":"packages/module/src/types.ts","line":13,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L13"}],"typeParameters":[{"id":3561,"name":"D","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":3562,"name":"N","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":3563,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":13,"character":55,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L13"}]}}}],"type":{"type":"intersection","types":[{"type":"reference","target":3562,"name":"N","package":"@boost/module","refersToTypeParameter":true},{"type":"reflection","declaration":{"id":3558,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3560,"name":"__esModule","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/module/src/types.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":3559,"name":"default","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L14"}],"type":{"type":"conditional","checkType":{"type":"reference","target":3561,"name":"D","package":"@boost/module","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"void"},"trueType":{"type":"reference","target":3562,"name":"N","package":"@boost/module","refersToTypeParameter":true},"falseType":{"type":"reference","target":3561,"name":"D","package":"@boost/module","refersToTypeParameter":true}}}],"groups":[{"title":"Properties","children":[3560,3559]}],"sources":[{"fileName":"packages/module/src/types.ts","line":13,"character":65,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L13"}]}}]},"permalink":"/api/module#ModuleLike","previousId":3547,"nextId":3564},{"id":3564,"name":"PathLike","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L18"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reflection","declaration":{"id":3565,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3566,"name":"toString","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":18,"character":34,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L18"}],"type":{"type":"reflection","declaration":{"id":3567,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":18,"character":44,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L18"}],"signatures":[{"id":3568,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"string"}}]}}}],"groups":[{"title":"Properties","children":[3566]}],"sources":[{"fileName":"packages/module/src/types.ts","line":18,"character":32,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L18"}]}}]},"permalink":"/api/module#PathLike","previousId":3557},{"id":3532,"name":"interopModule","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/interopModule.ts","line":16,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/interopModule.ts#L16"}],"signatures":[{"id":3533,"name":"interopModule","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Formats the shape of an imported module to align with the\\nES module specification.\\n\\nFor ES or ES-like modules, returns the shape as-is.\\n\\nFor CommonJS modules, returns an object with the following:\\n- "},{"kind":"code","text":"`module.exports`"},{"kind":"text","text":" under the "},{"kind":"code","text":"`default`"},{"kind":"text","text":" property.\\n- "},{"kind":"code","text":"`exports.`"},{"kind":"text","text":" under properties of the same name,\\n and also under a "},{"kind":"code","text":"`default`"},{"kind":"text","text":" object."}]},"sources":[{"fileName":"packages/module/src/interopModule.ts","line":16,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/interopModule.ts#L16"}],"typeParameter":[{"id":3534,"name":"D","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":3535,"name":"N","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":3536,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":3537,"name":"result","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":3557,"typeArguments":[{"type":"reference","target":3534,"name":"D","package":"@boost/module","refersToTypeParameter":true},{"type":"reference","target":3535,"name":"N","package":"@boost/module","refersToTypeParameter":true}],"name":"ModuleLike","package":"@boost/module"}}],"permalink":"/api/module/function/interopModule","nextId":3545},{"id":3545,"name":"registerExtensions","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":48,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L48"}],"signatures":[{"id":3546,"name":"registerExtensions","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register "},{"kind":"code","text":"`.ts`"},{"kind":"text","text":" and "},{"kind":"code","text":"`.tsx`"},{"kind":"text","text":" file extensions into Node.js\'s resolution algorithm."}]},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":48,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L48"}],"type":{"type":"intrinsic","name":"void"}}],"permalink":"/api/module/function/registerExtensions","previousId":3532,"nextId":3538},{"id":3538,"name":"requireModule","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/requireModule.ts","line":33,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireModule.ts#L33"}],"signatures":[{"id":3539,"name":"requireModule","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Works in a similar fashion to the native NodeJS "},{"kind":"code","text":"`require()`"},{"kind":"text","text":", but can also\\nimport custom file types like TypeScript, and also returns a module shape\\nthat aligns with the ESM loader specification.\\n\\nWhen loading custom file types, the extension in the file path is optional,\\nas NodeJS will iterate through each extension until a file is found.\\n\\n"},{"kind":"code","text":"```ts\\nimport { requireModule } from \'@boost/module\';\\n\\nconst result = requireModule(\'../../some/module\');\\n```"},{"kind":"text","text":"\\n\\nCaveats and differences:\\n\\n- CommonJS files that utilize "},{"kind":"code","text":"`module.exports`"},{"kind":"text","text":" (default export) will have this\\n value returned under a "},{"kind":"code","text":"`default`"},{"kind":"text","text":" property, instead of being returned directly.\\n- CommonJS files that utilize multiple "},{"kind":"code","text":"`exports.`"},{"kind":"text","text":" (named exports) will\\n have these values returned as properties on the result object, and will also\\n be found on the "},{"kind":"code","text":"`default`"},{"kind":"text","text":" property.\\n- \\"ES module like\\" files will be returned as-is. These are files that are built\\n with Babel or TypeScript and export an "},{"kind":"code","text":"`__esModule`"},{"kind":"text","text":" internal property.\\n\\nThese changes align with "},{"kind":"code","text":"`import()`"},{"kind":"text","text":" and the ES module system. We made this\\ndecision for consistency and reliability."}]},"sources":[{"fileName":"packages/module/src/requireModule.ts","line":33,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireModule.ts#L33"}],"typeParameter":[{"id":3540,"name":"D","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":3541,"name":"N","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":3542,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":3543,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3564,"name":"PathLike","package":"@boost/module"}},{"id":3544,"name":"requirer","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeRequire"},"name":"NodeRequire","package":"@types/node","qualifiedName":"__global.NodeRequire"},"defaultValue":"require"}],"type":{"type":"reference","target":3557,"typeArguments":[{"type":"reference","target":3540,"name":"D","package":"@boost/module","refersToTypeParameter":true},{"type":"reference","target":3541,"name":"N","package":"@boost/module","refersToTypeParameter":true}],"name":"ModuleLike","package":"@boost/module"}}],"permalink":"/api/module/function/requireModule","previousId":3545,"nextId":3549},{"id":3549,"name":"requireTSModule","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L80"}],"signatures":[{"id":3550,"name":"requireTSModule","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`requireModule`"},{"kind":"text","text":" but for loading TypeScript files ending in "},{"kind":"code","text":"`ts`"},{"kind":"text","text":" or "},{"kind":"code","text":"`tsx`"},{"kind":"text","text":".\\nWhen imported, will transform the file using the "},{"kind":"code","text":"`typescript`"},{"kind":"text","text":" package,\\nevaluate the code in the current module context, and apply the same process\\nto all child imports.\\n\\n"},{"kind":"code","text":"```ts\\nimport { requireTSModule } from \'@boost/module\';\\n\\nconst result = requireTSModule(\'../../some/module.ts\');\\n```"},{"kind":"text","text":"\\n\\n> This helper rarely needs to be used directly as "},{"kind":"code","text":"`requireModule`"},{"kind":"text","text":" will\\n> call it under the hood based on the file extension."}]},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L80"}],"typeParameter":[{"id":3551,"name":"D","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":3552,"name":"N","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":3553,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":3554,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3564,"name":"PathLike","package":"@boost/module"}},{"id":3555,"name":"requirer","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeRequire"},"name":"NodeRequire","package":"@types/node","qualifiedName":"__global.NodeRequire"},"defaultValue":"require"}],"type":{"type":"reference","target":3557,"typeArguments":[{"type":"reference","target":3551,"name":"D","package":"@boost/module","refersToTypeParameter":true},{"type":"reference","target":3552,"name":"N","package":"@boost/module","refersToTypeParameter":true}],"name":"ModuleLike","package":"@boost/module"}}],"permalink":"/api/module/function/requireTSModule","previousId":3538,"nextId":3547},{"id":3547,"name":"unregisterExtensions","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L58"}],"signatures":[{"id":3548,"name":"unregisterExtensions","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unregister "},{"kind":"code","text":"`.ts`"},{"kind":"text","text":" and "},{"kind":"code","text":"`.tsx`"},{"kind":"text","text":" file extensions."}]},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L58"}],"type":{"type":"intrinsic","name":"void"}}],"permalink":"/api/module/function/unregisterExtensions","previousId":3549,"nextId":3557}],"groups":[{"title":"Functions","children":[3532,3545,3538,3549,3547]},{"title":"Type Aliases","children":[3557,3564]}],"sources":[{"fileName":"packages/module/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/index.ts#L1"}],"permalink":"/api/module"},"urlSlug":"module"},{"index":false,"label":"Node.js hooks","reflection":{"id":100,"name":"@boost/module/loader","variant":"declaration","kind":2,"flags":{},"sources":[{"fileName":"packages/module/src/hooks/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/hooks/index.ts#L1"}],"permalink":"/api/module-loader"},"urlSlug":"module-loader"}],"packageName":"@boost/module","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":5,"name":"@boost/pipeline","variant":"declaration","kind":2,"flags":{},"children":[{"id":848,"name":"AggregatedPipeline","variant":"declaration","kind":128,"flags":{},"children":[{"id":850,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":851,"name":"new AggregatedPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":852,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":853,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":854,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":855,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true}},{"id":856,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}},{"id":857,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":858,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"type":{"type":"reference","target":848,"typeArguments":[{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"AggregatedPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":998,"name":"ParallelPipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":997,"name":"ParallelPipeline.constructor"}},{"id":877,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1024,"name":"ParallelPipeline.context"}},{"id":878,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":1025,"name":"ParallelPipeline.debug"}},{"id":875,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1022,"name":"ParallelPipeline.depth"}},{"id":876,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1023,"name":"ParallelPipeline.index"}},{"id":880,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1027,"name":"ParallelPipeline.onAfterRun"}},{"id":881,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1028,"name":"ParallelPipeline.onBeforeRun"}},{"id":882,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":883,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1029,"name":"ParallelPipeline.onRunWorkUnit"}},{"id":895,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":896,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1042,"name":"ParallelPipeline.options"}},{"id":879,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1026,"name":"ParallelPipeline.value"}},{"id":887,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":888,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParallelPipeline.id"}},"inheritedFrom":{"type":"reference","target":1034,"name":"ParallelPipeline.id"}},{"id":864,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L25"}],"signatures":[{"id":865,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a work unit to the list of items to process."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"}],"parameters":[{"id":866,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":867,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":868,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1010,"name":"ParallelPipeline.add"}},{"id":869,"name":"add","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"}],"parameters":[{"id":870,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":871,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1014,"name":"ParallelPipeline.add"}}],"inheritedFrom":{"type":"reference","target":1009,"name":"ParallelPipeline.add"}},{"id":861,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"signatures":[{"id":862,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"parameters":[{"id":863,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":1007,"name":"ParallelPipeline.blueprint"}}],"inheritedFrom":{"type":"reference","target":1006,"name":"ParallelPipeline.blueprint"}},{"id":897,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":898,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":899,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":900,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":901,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":902,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":903,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":904,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":905,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":906,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1044,"name":"ParallelPipeline.configure"}}],"inheritedFrom":{"type":"reference","target":1043,"name":"ParallelPipeline.configure"}},{"id":889,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"signatures":[{"id":890,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of registered work units for the current pipeline."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":891,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":1037,"name":"ParallelPipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":1036,"name":"ParallelPipeline.getWorkUnits"}},{"id":892,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":893,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":894,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1040,"name":"ParallelPipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":1039,"name":"ParallelPipeline.monitor"}},{"id":859,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/AggregatedPipeline.ts","line":15,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/AggregatedPipeline.ts#L15"}],"signatures":[{"id":860,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute all work units in parallel with a value being passed to each work unit.\\nWork units will synchronize regardless of race conditions and errors."}]},"sources":[{"fileName":"packages/pipeline/src/AggregatedPipeline.ts","line":15,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/AggregatedPipeline.ts#L15"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1369,"typeArguments":[{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"AggregatedResult","package":"@boost/pipeline"}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":1021,"name":"ParallelPipeline.run"}}],"overwrites":{"type":"reference","target":1020,"name":"ParallelPipeline.run"}}],"groups":[{"title":"Constructors","children":[850]},{"title":"Properties","children":[877,878,875,876,880,881,882,895,879]},{"title":"Accessors","children":[887]},{"title":"Methods","children":[864,861,897,889,892,859]}],"categories":[{"title":"Events","children":[880,881,882]},{"title":"__CATEGORY__","children":[850,877,878,875,876,895,879,887,864,861,897,889,892,859]}],"sources":[{"fileName":"packages/pipeline/src/AggregatedPipeline.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/AggregatedPipeline.ts#L6"}],"typeParameters":[{"id":907,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":908,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":909,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":996,"typeArguments":[{"type":"reflection","declaration":{"id":849,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/AggregatedPipeline.ts","line":10,"character":27,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/AggregatedPipeline.ts#L10"}]}},{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"ParallelPipeline","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/AggregatedPipeline","nextId":910},{"id":910,"name":"ConcurrentPipeline","variant":"declaration","kind":128,"flags":{},"children":[{"id":912,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":913,"name":"new ConcurrentPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":914,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":915,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":916,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":917,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true}},{"id":918,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}},{"id":919,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":920,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"type":{"type":"reference","target":910,"typeArguments":[{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"ConcurrentPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":998,"name":"ParallelPipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":997,"name":"ParallelPipeline.constructor"}},{"id":939,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1024,"name":"ParallelPipeline.context"}},{"id":940,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":1025,"name":"ParallelPipeline.debug"}},{"id":937,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1022,"name":"ParallelPipeline.depth"}},{"id":938,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1023,"name":"ParallelPipeline.index"}},{"id":942,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1027,"name":"ParallelPipeline.onAfterRun"}},{"id":943,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1028,"name":"ParallelPipeline.onBeforeRun"}},{"id":944,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":945,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1029,"name":"ParallelPipeline.onRunWorkUnit"}},{"id":957,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":958,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1042,"name":"ParallelPipeline.options"}},{"id":941,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1026,"name":"ParallelPipeline.value"}},{"id":949,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":950,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParallelPipeline.id"}},"inheritedFrom":{"type":"reference","target":1034,"name":"ParallelPipeline.id"}},{"id":926,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L25"}],"signatures":[{"id":927,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a work unit to the list of items to process."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"}],"parameters":[{"id":928,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":929,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":930,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1010,"name":"ParallelPipeline.add"}},{"id":931,"name":"add","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"}],"parameters":[{"id":932,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":933,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1014,"name":"ParallelPipeline.add"}}],"inheritedFrom":{"type":"reference","target":1009,"name":"ParallelPipeline.add"}},{"id":923,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"signatures":[{"id":924,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"parameters":[{"id":925,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":1007,"name":"ParallelPipeline.blueprint"}}],"inheritedFrom":{"type":"reference","target":1006,"name":"ParallelPipeline.blueprint"}},{"id":959,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":960,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":961,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":962,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":963,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":964,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":965,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":966,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":967,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":968,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1044,"name":"ParallelPipeline.configure"}}],"inheritedFrom":{"type":"reference","target":1043,"name":"ParallelPipeline.configure"}},{"id":951,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"signatures":[{"id":952,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of registered work units for the current pipeline."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":953,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":1037,"name":"ParallelPipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":1036,"name":"ParallelPipeline.getWorkUnits"}},{"id":954,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":955,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":956,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1040,"name":"ParallelPipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":1039,"name":"ParallelPipeline.monitor"}},{"id":921,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ConcurrentPipeline.ts","line":14,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ConcurrentPipeline.ts#L14"}],"signatures":[{"id":922,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute all work units in parallel with a value being passed to each work unit.\\nIf an error occurs, the pipeline will abort early, otherwise return a list of all results."}]},"sources":[{"fileName":"packages/pipeline/src/ConcurrentPipeline.ts","line":14,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ConcurrentPipeline.ts#L14"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":1021,"name":"ParallelPipeline.run"}}],"overwrites":{"type":"reference","target":1020,"name":"ParallelPipeline.run"}}],"groups":[{"title":"Constructors","children":[912]},{"title":"Properties","children":[939,940,937,938,942,943,944,957,941]},{"title":"Accessors","children":[949]},{"title":"Methods","children":[926,923,959,951,954,921]}],"categories":[{"title":"Events","children":[942,943,944]},{"title":"__CATEGORY__","children":[912,939,940,937,938,957,941,949,926,923,959,951,954,921]}],"sources":[{"fileName":"packages/pipeline/src/ConcurrentPipeline.ts","line":5,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ConcurrentPipeline.ts#L5"}],"typeParameters":[{"id":969,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":970,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":971,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":996,"typeArguments":[{"type":"reflection","declaration":{"id":911,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ConcurrentPipeline.ts","line":9,"character":27,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ConcurrentPipeline.ts#L9"}]}},{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"ParallelPipeline","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/ConcurrentPipeline","previousId":848,"nextId":977},{"id":977,"name":"Context","variant":"declaration","kind":128,"flags":{},"children":[{"id":978,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":979,"name":"new Context","variant":"signature","kind":16384,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}}]},{"id":980,"name":"clone","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Context.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Context.ts#L15"}],"signatures":[{"id":981,"name":"clone","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create a new instance of the current context and shallow clone all properties."}]},"sources":[{"fileName":"packages/pipeline/src/Context.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Context.ts#L15"}],"parameters":[{"id":982,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[978]},{"title":"Methods","children":[980]}],"sources":[{"fileName":"packages/pipeline/src/Context.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Context.ts#L11"}],"permalink":"/api/pipeline/class/Context","previousId":910,"nextId":983},{"id":983,"name":"Monitor","variant":"declaration","kind":128,"flags":{},"children":[{"id":984,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":985,"name":"new Monitor","variant":"signature","kind":16384,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}]},{"id":986,"name":"onPipelineAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a pipeline class has ran."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1386,"name":"AnyPipeline","package":"@boost/pipeline"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":987,"name":"onPipelineBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a pipeline class is ran."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":18,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1386,"name":"AnyPipeline","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":988,"name":"onPipelineRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a pipeline\'s work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":24,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L24"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1386,"name":"AnyPipeline","package":"@boost/pipeline"},{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":989,"name":"onWorkUnitFail","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when any work unit has failed."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":30,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L30"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":990,"name":"onWorkUnitPass","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when any work unit has passed."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":36,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":991,"name":"onWorkUnitRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when any work unit is ran."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":42,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/BailEvent.ts","qualifiedName":"BailEvent"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"BailEvent","package":"@boost/event"},"defaultValue":"..."},{"id":992,"name":"onWorkUnitSkip","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when any work unit is skipped."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L48"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":993,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":54,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L54"}],"signatures":[{"id":994,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor events for the provided pipeline, its work units, and all other\\npipelines and work units down the hierarchical tree."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":54,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L54"}],"parameters":[{"id":995,"name":"pipeline","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1386,"name":"AnyPipeline","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[984]},{"title":"Properties","children":[986,987,988,989,990,991,992]},{"title":"Methods","children":[993]}],"categories":[{"title":"Events","children":[986,987,988,989,990,991,992]},{"title":"__CATEGORY__","children":[984,993]}],"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L7"}],"permalink":"/api/pipeline/class/Monitor","previousId":977,"nextId":996},{"id":996,"name":"ParallelPipeline","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":997,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":998,"name":"new ParallelPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":999,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1000,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1001,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1002,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":1003,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true}},{"id":1004,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}},{"id":1005,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":996,"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"ParallelPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.constructor"}},{"id":1024,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.context"}},{"id":1025,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.debug"}},{"id":1022,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.depth"}},{"id":1023,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.index"}},{"id":1027,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onAfterRun"}},{"id":1028,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onBeforeRun"}},{"id":1029,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1030,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onRunWorkUnit"}},{"id":1042,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.options"}},{"id":1026,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.value"}},{"id":1034,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":1035,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.id"}},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.id"}},{"id":1009,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L25"}],"signatures":[{"id":1010,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a work unit to the list of items to process."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"}],"parameters":[{"id":1011,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1012,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1013,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"this"}},{"id":1014,"name":"add","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"}],"parameters":[{"id":1015,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1016,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":1006,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"signatures":[{"id":1007,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"parameters":[{"id":1008,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"overwrites":{"type":"reference","target":-1,"name":"Pipeline.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Pipeline.blueprint"}},{"id":1043,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1044,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1045,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1046,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1047,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1048,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.configure"}},{"id":1036,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"signatures":[{"id":1037,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of registered work units for the current pipeline."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1038,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.getWorkUnits"}},{"id":1039,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":1040,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":1041,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.monitor"}},{"id":1020,"name":"run","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":61,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L61"}],"signatures":[{"id":1021,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run and process the work unit\'s asynchronously."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":61,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L61"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[997]},{"title":"Properties","children":[1024,1025,1022,1023,1027,1028,1029,1042,1026]},{"title":"Accessors","children":[1034]},{"title":"Methods","children":[1009,1006,1043,1036,1039,1020]}],"categories":[{"title":"Events","children":[1027,1028,1029]},{"title":"__CATEGORY__","children":[997,1024,1025,1022,1023,1042,1026,1034,1009,1006,1043,1036,1039,1020]}],"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":9,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L9"}],"typeParameters":[{"id":1049,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1050,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1051,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1052,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/pipeline/src/Pipeline.ts","qualifiedName":"Pipeline"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"Pipeline","package":"@boost/pipeline"}],"extendedBy":[{"type":"reference","target":848,"name":"AggregatedPipeline"},{"type":"reference","target":910,"name":"ConcurrentPipeline"},{"type":"reference","target":1063,"name":"PooledPipeline"}],"permalink":"/api/pipeline/class/ParallelPipeline","previousId":983,"nextId":1063},{"id":1063,"name":"PooledPipeline","variant":"declaration","kind":128,"flags":{},"children":[{"id":1064,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":1065,"name":"new PooledPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":1066,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1067,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1068,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":1069,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true}},{"id":1070,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}},{"id":1071,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}}],"type":{"type":"reference","target":1063,"typeArguments":[{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"PooledPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":998,"name":"ParallelPipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":997,"name":"ParallelPipeline.constructor"}},{"id":1101,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1024,"name":"ParallelPipeline.context"}},{"id":1102,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":1025,"name":"ParallelPipeline.debug"}},{"id":1099,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1022,"name":"ParallelPipeline.depth"}},{"id":1100,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1023,"name":"ParallelPipeline.index"}},{"id":1104,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1027,"name":"ParallelPipeline.onAfterRun"}},{"id":1105,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1028,"name":"ParallelPipeline.onBeforeRun"}},{"id":1106,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1107,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1029,"name":"ParallelPipeline.onRunWorkUnit"}},{"id":1119,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1042,"name":"ParallelPipeline.options"}},{"id":1103,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1026,"name":"ParallelPipeline.value"}},{"id":1111,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":1112,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParallelPipeline.id"}},"inheritedFrom":{"type":"reference","target":1034,"name":"ParallelPipeline.id"}},{"id":1088,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L25"}],"signatures":[{"id":1089,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a work unit to the list of items to process."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"}],"parameters":[{"id":1090,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1091,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1092,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1010,"name":"ParallelPipeline.add"}},{"id":1093,"name":"add","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"}],"parameters":[{"id":1094,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1095,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1014,"name":"ParallelPipeline.add"}}],"inheritedFrom":{"type":"reference","target":1009,"name":"ParallelPipeline.add"}},{"id":1079,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":34,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L34"}],"signatures":[{"id":1080,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":34,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L34"}],"parameters":[{"id":1081,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":1007,"name":"ParallelPipeline.blueprint"}}],"overwrites":{"type":"reference","target":1006,"name":"ParallelPipeline.blueprint"}},{"id":1120,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1121,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1122,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1123,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1124,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1125,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1044,"name":"ParallelPipeline.configure"}}],"inheritedFrom":{"type":"reference","target":1043,"name":"ParallelPipeline.configure"}},{"id":1113,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"signatures":[{"id":1114,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of registered work units for the current pipeline."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1115,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":1037,"name":"ParallelPipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":1036,"name":"ParallelPipeline.getWorkUnits"}},{"id":1116,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":1117,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":1118,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1040,"name":"ParallelPipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":1039,"name":"ParallelPipeline.monitor"}},{"id":1082,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":49,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L49"}],"signatures":[{"id":1083,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute all work units in parallel, in a pool with a max concurrency,\\nwith a value being passed to each work unit.\\nWork units will synchronize regardless of race conditions and errors."}]},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":49,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L49"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1369,"typeArguments":[{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"AggregatedResult","package":"@boost/pipeline"}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":1021,"name":"ParallelPipeline.run"}}],"overwrites":{"type":"reference","target":1020,"name":"ParallelPipeline.run"}}],"groups":[{"title":"Constructors","children":[1064]},{"title":"Properties","children":[1101,1102,1099,1100,1104,1105,1106,1119,1103]},{"title":"Accessors","children":[1111]},{"title":"Methods","children":[1088,1079,1120,1113,1116,1082]}],"categories":[{"title":"Events","children":[1104,1105,1106]},{"title":"__CATEGORY__","children":[1064,1101,1102,1099,1100,1119,1103,1111,1088,1079,1120,1113,1116,1082]}],"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":23,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L23"}],"typeParameters":[{"id":1126,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1127,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1128,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":996,"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"},{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"ParallelPipeline","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/PooledPipeline","previousId":996,"nextId":1135},{"id":1135,"name":"Routine","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1136,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L47"}],"signatures":[{"id":1137,"name":"new Routine","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L47"}],"typeParameter":[{"id":1138,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1139,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1140,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1141,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":1142,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":1143,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1144,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1135,"typeArguments":[{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true},{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true},{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Routine","package":"@boost/pipeline"},"overwrites":{"type":"reference","target":1455,"name":"WorkUnit.constructor"}}],"overwrites":{"type":"reference","target":1454,"name":"WorkUnit.constructor"}},{"id":1145,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"}},{"id":1195,"name":"depth","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current depth of nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L18"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1462,"name":"WorkUnit.depth"}},{"id":1196,"name":"index","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current index amongst sibling work units."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L20"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1463,"name":"WorkUnit.index"}},{"id":1198,"name":"input","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L24"}],"type":{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1465,"name":"WorkUnit.input"}},{"id":1146,"name":"key","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":31,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L31"}],"type":{"type":"intrinsic","name":"string"}},{"id":1147,"name":"onCommand","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after "},{"kind":"code","text":"`execa`"},{"kind":"text","text":" was executed."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":37,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L37"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1148,"name":"onCommandData","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called while a command is being executed."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":43,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L43"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1202,"name":"onFail","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution fails."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":36,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]},{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1469,"name":"WorkUnit.onFail"}},{"id":1203,"name":"onPass","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution succeeds."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":42,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true},{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1470,"name":"WorkUnit.onPass"}},{"id":1204,"name":"onRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a work unit is executed. Can return "},{"kind":"code","text":"`true`"},{"kind":"text","text":" to skip the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L48"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/BailEvent.ts","qualifiedName":"BailEvent"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"BailEvent","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1471,"name":"WorkUnit.onRun"}},{"id":1205,"name":"onSkip","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution is skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":54,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L54"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1472,"name":"WorkUnit.onSkip"}},{"id":1228,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1497,"name":"WorkUnit.options"}},{"id":1197,"name":"output","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L22"}],"type":{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1464,"name":"WorkUnit.output"}},{"id":1199,"name":"startTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L26"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1466,"name":"WorkUnit.startTime"}},{"id":1200,"name":"statusText","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L28"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'","inheritedFrom":{"type":"reference","target":1467,"name":"WorkUnit.statusText"}},{"id":1201,"name":"stopTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L30"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1468,"name":"WorkUnit.stopTime"}},{"id":1206,"name":"title","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":56,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L56"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":1473,"name":"WorkUnit.title"}},{"id":1207,"name":"id","variant":"declaration","kind":262144,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique ID of the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"getSignature":{"id":1208,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"WorkUnit.id"}},"inheritedFrom":{"type":"reference","target":1476,"name":"WorkUnit.id"}},{"id":1235,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"signatures":[{"id":1236,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"parameters":[{"id":1237,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":1238,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":1505,"name":"WorkUnit.blueprint"}}],"inheritedFrom":{"type":"reference","target":1504,"name":"WorkUnit.blueprint"}},{"id":1229,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1230,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1231,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1232,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1233,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1234,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1499,"name":"WorkUnit.configure"}}],"inheritedFrom":{"type":"reference","target":1498,"name":"WorkUnit.configure"}},{"id":1156,"name":"createAggregatedPipeline","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":103,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L103"}],"signatures":[{"id":1157,"name":"createAggregatedPipeline","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`AggregatedPipeline`"},{"kind":"text","text":". This pipeline will execute all work units\\nin parallel without interruption. Returns an object with a list of errors and results\\nonce all resolve."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":103,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L103"}],"typeParameter":[{"id":1158,"name":"C","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1159,"name":"I","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1160,"name":"O","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1159,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"parameters":[{"id":1161,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1158,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1162,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1159,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"type":{"type":"reference","target":848,"typeArguments":[{"type":"reference","target":1158,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1159,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1160,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"AggregatedPipeline","package":"@boost/pipeline"}}]},{"id":1163,"name":"createConcurrentPipeline","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":111,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L111"}],"signatures":[{"id":1164,"name":"createConcurrentPipeline","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`ConcurrentPipeline`"},{"kind":"text","text":". This pipeline will execute all work units\\nin parallel. Returns a list of values once all resolve."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":111,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L111"}],"typeParameter":[{"id":1165,"name":"C","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1166,"name":"I","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1167,"name":"O","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1166,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"parameters":[{"id":1168,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1165,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1169,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1166,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"type":{"type":"reference","target":910,"typeArguments":[{"type":"reference","target":1165,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1166,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1167,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"ConcurrentPipeline","package":"@boost/pipeline"}}]},{"id":1170,"name":"createPooledPipeline","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":120,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L120"}],"signatures":[{"id":1171,"name":"createPooledPipeline","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`PooledPipeline`"},{"kind":"text","text":". This pipeline will execute a distinct set of work units\\nin parallel without interruption, based on a max concurrency, until all work units have ran.\\nReturns a list of errors and results once all resolve."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":120,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L120"}],"typeParameter":[{"id":1172,"name":"C","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1173,"name":"I","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1174,"name":"O","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1173,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"parameters":[{"id":1175,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1172,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1176,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1173,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1177,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}}],"type":{"type":"reference","target":1063,"typeArguments":[{"type":"reference","target":1172,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1173,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1174,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"PooledPipeline","package":"@boost/pipeline"}}]},{"id":1178,"name":"createWaterfallPipeline","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":133,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L133"}],"signatures":[{"id":1179,"name":"createWaterfallPipeline","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`WaterfallPipeline`"},{"kind":"text","text":". This pipeline will execute each work unit one by one,\\nwith the return value of the previous being passed to the next. Returns the final value once\\nall resolve."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":133,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L133"}],"typeParameter":[{"id":1180,"name":"C","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1181,"name":"I","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":1182,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1180,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1183,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1181,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"type":{"type":"reference","target":1390,"typeArguments":[{"type":"reference","target":1180,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1181,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"WaterfallPipeline","package":"@boost/pipeline"}}]},{"id":1191,"name":"execute","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":163,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L163"}],"signatures":[{"id":1192,"name":"execute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute the current routine and return a new value."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":163,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L163"}],"parameters":[{"id":1193,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1194,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]},{"id":1150,"name":"executeCommand","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":64,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L64"}],"signatures":[{"id":1151,"name":"executeCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute a command with the given arguments and pass the results through a promise."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":64,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L64"}],"parameters":[{"id":1152,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1153,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":1154,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"intersection","types":[{"type":"reflection","declaration":{"id":1155,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"node_modules/execa/index.d.ts","line":276,"character":83}]}},{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"CommonOptions"},"typeArguments":[{"type":"literal","value":"utf8"}],"name":"CommonOptions","package":"execa"},{"type":"reference","target":1129,"name":"ExecuteCommandOptions","package":"@boost/pipeline"}]},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"ExecaReturnValue"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"ExecaReturnValue","package":"execa"}],"name":"Promise","package":"typescript"}}]},{"id":1209,"name":"hasFailed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"signatures":[{"id":1210,"name":"hasFailed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task failed when executing."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1479,"name":"WorkUnit.hasFailed"}}],"inheritedFrom":{"type":"reference","target":1478,"name":"WorkUnit.hasFailed"}},{"id":1211,"name":"hasPassed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"signatures":[{"id":1212,"name":"hasPassed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task executed successfully."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1481,"name":"WorkUnit.hasPassed"}}],"inheritedFrom":{"type":"reference","target":1480,"name":"WorkUnit.hasPassed"}},{"id":1213,"name":"isComplete","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"signatures":[{"id":1214,"name":"isComplete","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has been completed in any form."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1483,"name":"WorkUnit.isComplete"}}],"inheritedFrom":{"type":"reference","target":1482,"name":"WorkUnit.isComplete"}},{"id":1215,"name":"isPending","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"signatures":[{"id":1216,"name":"isPending","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has not been executed yet."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1485,"name":"WorkUnit.isPending"}}],"inheritedFrom":{"type":"reference","target":1484,"name":"WorkUnit.isPending"}},{"id":1217,"name":"isRunning","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"signatures":[{"id":1218,"name":"isRunning","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task is currently running."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1487,"name":"WorkUnit.isRunning"}}],"inheritedFrom":{"type":"reference","target":1486,"name":"WorkUnit.isRunning"}},{"id":1219,"name":"isSkipped","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"signatures":[{"id":1220,"name":"isSkipped","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task was or will be skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1489,"name":"WorkUnit.isSkipped"}}],"inheritedFrom":{"type":"reference","target":1488,"name":"WorkUnit.isSkipped"}},{"id":1221,"name":"run","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"signatures":[{"id":1222,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the current task by executing it and performing any before and after processes."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"parameters":[{"id":1223,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1224,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","target":1491,"name":"WorkUnit.run"}}],"inheritedFrom":{"type":"reference","target":1490,"name":"WorkUnit.run"}},{"id":1184,"name":"setMonitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L140"}],"signatures":[{"id":1185,"name":"setMonitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set the monitor to pass to nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L140"}],"parameters":[{"id":1186,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":1225,"name":"skip","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"signatures":[{"id":1226,"name":"skip","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mark a task as skipped if the condition is true."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"parameters":[{"id":1227,"name":"condition","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true"}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1495,"name":"WorkUnit.skip"}}],"inheritedFrom":{"type":"reference","target":1494,"name":"WorkUnit.skip"}}],"groups":[{"title":"Constructors","children":[1136]},{"title":"Properties","children":[1145,1195,1196,1198,1146,1147,1148,1202,1203,1204,1205,1228,1197,1199,1200,1201,1206]},{"title":"Accessors","children":[1207]},{"title":"Methods","children":[1235,1229,1156,1163,1170,1178,1191,1150,1209,1211,1213,1215,1217,1219,1221,1184,1225]}],"categories":[{"title":"Events","children":[1147,1148,1202,1203,1204,1205]},{"title":"__CATEGORY__","children":[1136,1145,1195,1196,1198,1146,1228,1197,1199,1200,1201,1206,1207,1235,1229,1156,1163,1170,1178,1191,1150,1209,1211,1213,1215,1217,1219,1221,1184,1225]}],"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":24,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L24"}],"typeParameters":[{"id":1239,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1240,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1241,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1242,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":27,"character":26,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L27"}]}}}],"extendedTypes":[{"type":"reference","target":1453,"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true},{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true},{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/Routine","previousId":1063,"nextId":1243},{"id":1243,"name":"SerialPipeline","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1244,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":1245,"name":"new SerialPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":1246,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1247,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1248,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1249,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":1250,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true}},{"id":1251,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}},{"id":1252,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.constructor"}},{"id":1274,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.context"}},{"id":1275,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.debug"}},{"id":1272,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.depth"}},{"id":1273,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.index"}},{"id":1277,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onAfterRun"}},{"id":1278,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onBeforeRun"}},{"id":1279,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1280,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onRunWorkUnit"}},{"id":1289,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.options"}},{"id":1253,"name":"root","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L17"}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"SerialPipeline","package":"@boost/pipeline"},"defaultValue":"..."},{"id":1276,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.value"}},{"id":1284,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":1285,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.id"}},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.id"}},{"id":1254,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L20"}],"signatures":[{"id":1255,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L20"}],"parameters":[{"id":1256,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"overwrites":{"type":"reference","target":-1,"name":"Pipeline.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Pipeline.blueprint"}},{"id":1290,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1291,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1292,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1293,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1294,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1295,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.configure"}},{"id":1267,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L65"}],"signatures":[{"id":1268,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Traverse the linked list to return a list of work units in defined order."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L65"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1269,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"overwrites":{"type":"reference","target":-1,"name":"Pipeline.getWorkUnits"}}],"overwrites":{"type":"reference","target":-1,"name":"Pipeline.getWorkUnits"}},{"id":1286,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":1287,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":1288,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.monitor"}},{"id":1257,"name":"pipe","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L27"},{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L32"},{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L33"}],"signatures":[{"id":1258,"name":"pipe","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Pipe a work unit to be ran with the return value of the previous work unit."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L27"}],"typeParameter":[{"id":1259,"name":"O","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1260,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1261,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1262,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"}},{"id":1263,"name":"pipe","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L32"}],"typeParameter":[{"id":1264,"name":"O","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1265,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1266,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"}}]},{"id":1270,"name":"run","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":73,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L73"}],"signatures":[{"id":1271,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run and process the work units synchronously."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":73,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L73"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[1244]},{"title":"Properties","children":[1274,1275,1272,1273,1277,1278,1279,1289,1253,1276]},{"title":"Accessors","children":[1284]},{"title":"Methods","children":[1254,1290,1267,1286,1257,1270]}],"categories":[{"title":"Events","children":[1277,1278,1279]},{"title":"__CATEGORY__","children":[1244,1274,1275,1272,1273,1289,1253,1276,1284,1254,1290,1267,1286,1257,1270]}],"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":8,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L8"}],"typeParameters":[{"id":1296,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1297,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1298,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1299,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/pipeline/src/Pipeline.ts","qualifiedName":"Pipeline"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"Pipeline","package":"@boost/pipeline"}],"extendedBy":[{"type":"reference","target":1390,"name":"WaterfallPipeline"}],"permalink":"/api/pipeline/class/SerialPipeline","previousId":1135,"nextId":1300},{"id":1300,"name":"Task","variant":"declaration","kind":128,"flags":{},"children":[{"id":1302,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L65"}],"signatures":[{"id":1303,"name":"new Task","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L65"}],"typeParameter":[{"id":1304,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1305,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}}],"parameters":[{"id":1306,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1307,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true},{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1308,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":1309,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"type":{"type":"reference","target":1300,"typeArguments":[{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true},{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true}],"name":"Task","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":1455,"name":"WorkUnit.constructor"}}],"inheritedFrom":{"type":"reference","target":1454,"name":"WorkUnit.constructor"}},{"id":1313,"name":"depth","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current depth of nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L18"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1462,"name":"WorkUnit.depth"}},{"id":1314,"name":"index","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current index amongst sibling work units."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L20"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1463,"name":"WorkUnit.index"}},{"id":1316,"name":"input","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L24"}],"type":{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1465,"name":"WorkUnit.input"}},{"id":1320,"name":"onFail","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution fails."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":36,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]},{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1469,"name":"WorkUnit.onFail"}},{"id":1321,"name":"onPass","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution succeeds."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":42,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true},{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1470,"name":"WorkUnit.onPass"}},{"id":1322,"name":"onRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a work unit is executed. Can return "},{"kind":"code","text":"`true`"},{"kind":"text","text":" to skip the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L48"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/BailEvent.ts","qualifiedName":"BailEvent"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"BailEvent","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1471,"name":"WorkUnit.onRun"}},{"id":1323,"name":"onSkip","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution is skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":54,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L54"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1472,"name":"WorkUnit.onSkip"}},{"id":1346,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1347,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1497,"name":"WorkUnit.options"}},{"id":1315,"name":"output","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L22"}],"type":{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1464,"name":"WorkUnit.output"}},{"id":1317,"name":"startTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L26"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1466,"name":"WorkUnit.startTime"}},{"id":1318,"name":"statusText","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L28"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'","inheritedFrom":{"type":"reference","target":1467,"name":"WorkUnit.statusText"}},{"id":1319,"name":"stopTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L30"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1468,"name":"WorkUnit.stopTime"}},{"id":1324,"name":"title","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":56,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L56"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":1473,"name":"WorkUnit.title"}},{"id":1325,"name":"id","variant":"declaration","kind":262144,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique ID of the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"getSignature":{"id":1326,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"WorkUnit.id"}},"inheritedFrom":{"type":"reference","target":1476,"name":"WorkUnit.id"}},{"id":1310,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Task.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Task.ts#L7"}],"signatures":[{"id":1311,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/pipeline/src/Task.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Task.ts#L7"}],"parameters":[{"id":1312,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"overwrites":{"type":"reference","target":1505,"name":"WorkUnit.blueprint"}}],"overwrites":{"type":"reference","target":1504,"name":"WorkUnit.blueprint"}},{"id":1348,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1349,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1350,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":1351,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1352,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1353,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1354,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1355,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":1356,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1357,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1499,"name":"WorkUnit.configure"}}],"inheritedFrom":{"type":"reference","target":1498,"name":"WorkUnit.configure"}},{"id":1327,"name":"hasFailed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"signatures":[{"id":1328,"name":"hasFailed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task failed when executing."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1479,"name":"WorkUnit.hasFailed"}}],"inheritedFrom":{"type":"reference","target":1478,"name":"WorkUnit.hasFailed"}},{"id":1329,"name":"hasPassed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"signatures":[{"id":1330,"name":"hasPassed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task executed successfully."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1481,"name":"WorkUnit.hasPassed"}}],"inheritedFrom":{"type":"reference","target":1480,"name":"WorkUnit.hasPassed"}},{"id":1331,"name":"isComplete","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"signatures":[{"id":1332,"name":"isComplete","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has been completed in any form."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1483,"name":"WorkUnit.isComplete"}}],"inheritedFrom":{"type":"reference","target":1482,"name":"WorkUnit.isComplete"}},{"id":1333,"name":"isPending","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"signatures":[{"id":1334,"name":"isPending","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has not been executed yet."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1485,"name":"WorkUnit.isPending"}}],"inheritedFrom":{"type":"reference","target":1484,"name":"WorkUnit.isPending"}},{"id":1335,"name":"isRunning","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"signatures":[{"id":1336,"name":"isRunning","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task is currently running."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1487,"name":"WorkUnit.isRunning"}}],"inheritedFrom":{"type":"reference","target":1486,"name":"WorkUnit.isRunning"}},{"id":1337,"name":"isSkipped","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"signatures":[{"id":1338,"name":"isSkipped","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task was or will be skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1489,"name":"WorkUnit.isSkipped"}}],"inheritedFrom":{"type":"reference","target":1488,"name":"WorkUnit.isSkipped"}},{"id":1339,"name":"run","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"signatures":[{"id":1340,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the current task by executing it and performing any before and after processes."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"parameters":[{"id":1341,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1342,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","target":1491,"name":"WorkUnit.run"}}],"inheritedFrom":{"type":"reference","target":1490,"name":"WorkUnit.run"}},{"id":1343,"name":"skip","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"signatures":[{"id":1344,"name":"skip","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mark a task as skipped if the condition is true."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"parameters":[{"id":1345,"name":"condition","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true"}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1495,"name":"WorkUnit.skip"}}],"inheritedFrom":{"type":"reference","target":1494,"name":"WorkUnit.skip"}}],"groups":[{"title":"Constructors","children":[1302]},{"title":"Properties","children":[1313,1314,1316,1320,1321,1322,1323,1346,1315,1317,1318,1319,1324]},{"title":"Accessors","children":[1325]},{"title":"Methods","children":[1310,1348,1327,1329,1331,1333,1335,1337,1339,1343]}],"categories":[{"title":"Events","children":[1320,1321,1322,1323]},{"title":"__CATEGORY__","children":[1302,1313,1314,1316,1346,1315,1317,1318,1319,1324,1325,1310,1348,1327,1329,1331,1333,1335,1337,1339,1343]}],"sources":[{"fileName":"packages/pipeline/src/Task.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Task.ts#L4"}],"typeParameters":[{"id":1358,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1359,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1301,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Task.ts","line":4,"character":68,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Task.ts#L4"}]}},{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true},{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/Task","previousId":1243,"nextId":1390},{"id":1390,"name":"WaterfallPipeline","variant":"declaration","kind":128,"flags":{},"children":[{"id":1392,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":1393,"name":"new WaterfallPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":1394,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1395,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":1396,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true}},{"id":1397,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}},{"id":1398,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":1399,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"type":{"type":"reference","target":1390,"typeArguments":[{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"WaterfallPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":1245,"name":"SerialPipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":1244,"name":"SerialPipeline.constructor"}},{"id":1424,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1274,"name":"SerialPipeline.context"}},{"id":1425,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":1275,"name":"SerialPipeline.debug"}},{"id":1422,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1272,"name":"SerialPipeline.depth"}},{"id":1423,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1273,"name":"SerialPipeline.index"}},{"id":1427,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1277,"name":"SerialPipeline.onAfterRun"}},{"id":1428,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1278,"name":"SerialPipeline.onBeforeRun"}},{"id":1429,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1430,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1279,"name":"SerialPipeline.onRunWorkUnit"}},{"id":1439,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1440,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1289,"name":"SerialPipeline.options"}},{"id":1402,"name":"root","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L17"}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reflection","declaration":{"id":1403,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"SerialPipeline","package":"@boost/pipeline"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1253,"name":"SerialPipeline.root"}},{"id":1426,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1276,"name":"SerialPipeline.value"}},{"id":1434,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":1435,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"SerialPipeline.id"}},"inheritedFrom":{"type":"reference","target":1284,"name":"SerialPipeline.id"}},{"id":1404,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L20"}],"signatures":[{"id":1405,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L20"}],"parameters":[{"id":1406,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":1255,"name":"SerialPipeline.blueprint"}}],"inheritedFrom":{"type":"reference","target":1254,"name":"SerialPipeline.blueprint"}},{"id":1441,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1442,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1443,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":1444,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1445,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1446,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1447,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1448,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":1449,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1450,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1291,"name":"SerialPipeline.configure"}}],"inheritedFrom":{"type":"reference","target":1290,"name":"SerialPipeline.configure"}},{"id":1419,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L65"}],"signatures":[{"id":1420,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Traverse the linked list to return a list of work units in defined order."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L65"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1421,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":1268,"name":"SerialPipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":1267,"name":"SerialPipeline.getWorkUnits"}},{"id":1436,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":1437,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":1438,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1287,"name":"SerialPipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":1286,"name":"SerialPipeline.monitor"}},{"id":1407,"name":"pipe","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L27"},{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L32"},{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L33"}],"signatures":[{"id":1408,"name":"pipe","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Pipe a work unit to be ran with the return value of the previous work unit."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L27"}],"typeParameter":[{"id":1409,"name":"O","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1410,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1411,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1412,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reflection","declaration":{"id":1413,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":1258,"name":"SerialPipeline.pipe"}},{"id":1414,"name":"pipe","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L32"}],"typeParameter":[{"id":1415,"name":"O","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1416,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1417,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reflection","declaration":{"id":1418,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":1263,"name":"SerialPipeline.pipe"}}],"inheritedFrom":{"type":"reference","target":1257,"name":"SerialPipeline.pipe"}},{"id":1400,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WaterfallPipeline.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WaterfallPipeline.ts#L16"}],"signatures":[{"id":1401,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute the pipeline in sequential order with the output of each\\nwork unit being passed to the next work unit in the chain."}]},"sources":[{"fileName":"packages/pipeline/src/WaterfallPipeline.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WaterfallPipeline.ts#L16"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":1271,"name":"SerialPipeline.run"}}],"overwrites":{"type":"reference","target":1270,"name":"SerialPipeline.run"}}],"groups":[{"title":"Constructors","children":[1392]},{"title":"Properties","children":[1424,1425,1422,1423,1427,1428,1429,1439,1402,1426]},{"title":"Accessors","children":[1434]},{"title":"Methods","children":[1404,1441,1419,1436,1407,1400]}],"categories":[{"title":"Events","children":[1427,1428,1429]},{"title":"__CATEGORY__","children":[1392,1424,1425,1422,1423,1439,1402,1426,1434,1404,1441,1419,1436,1407,1400]}],"sources":[{"fileName":"packages/pipeline/src/WaterfallPipeline.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WaterfallPipeline.ts#L7"}],"typeParameters":[{"id":1451,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1452,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"extendedTypes":[{"type":"reference","target":1243,"typeArguments":[{"type":"reflection","declaration":{"id":1391,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WaterfallPipeline.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WaterfallPipeline.ts#L8"}]}},{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/WaterfallPipeline","previousId":1300,"nextId":1453},{"id":1453,"name":"WorkUnit","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1454,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L65"}],"signatures":[{"id":1455,"name":"new WorkUnit","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L65"}],"typeParameter":[{"id":1456,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1457,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1458,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}}],"parameters":[{"id":1459,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1460,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true},{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1461,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true},{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true},{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":1462,"name":"depth","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current depth of nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L18"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","implementationOf":{"type":"reference","target":1374,"name":"Hierarchical.depth"}},{"id":1463,"name":"index","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current index amongst sibling work units."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L20"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","implementationOf":{"type":"reference","target":1376,"name":"Hierarchical.index"}},{"id":1465,"name":"input","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L24"}],"type":{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}},{"id":1469,"name":"onFail","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution fails."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":36,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]},{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1470,"name":"onPass","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution succeeds."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":42,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true},{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1471,"name":"onRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a work unit is executed. Can return "},{"kind":"code","text":"`true`"},{"kind":"text","text":" to skip the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L48"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/BailEvent.ts","qualifiedName":"BailEvent"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"BailEvent","package":"@boost/event"},"defaultValue":"..."},{"id":1472,"name":"onSkip","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution is skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":54,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L54"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1497,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":1464,"name":"output","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L22"}],"type":{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}},{"id":1466,"name":"startTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L26"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0"},{"id":1467,"name":"statusText","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L28"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":1468,"name":"stopTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L30"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0"},{"id":1473,"name":"title","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":56,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L56"}],"type":{"type":"intrinsic","name":"string"}},{"id":1476,"name":"id","variant":"declaration","kind":262144,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique ID of the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"getSignature":{"id":1477,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":1375,"name":"Hierarchical.id"}},"implementationOf":{"type":"reference","target":1375,"name":"Hierarchical.id"}},{"id":1504,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"signatures":[{"id":1505,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"parameters":[{"id":1506,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":1507,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":1498,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1499,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1500,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1501,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1502,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1503,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":1478,"name":"hasFailed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"signatures":[{"id":1479,"name":"hasFailed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task failed when executing."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1480,"name":"hasPassed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"signatures":[{"id":1481,"name":"hasPassed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task executed successfully."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1482,"name":"isComplete","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"signatures":[{"id":1483,"name":"isComplete","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has been completed in any form."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1484,"name":"isPending","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"signatures":[{"id":1485,"name":"isPending","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has not been executed yet."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1486,"name":"isRunning","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"signatures":[{"id":1487,"name":"isRunning","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task is currently running."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1488,"name":"isSkipped","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"signatures":[{"id":1489,"name":"isSkipped","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task was or will be skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1490,"name":"run","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"signatures":[{"id":1491,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the current task by executing it and performing any before and after processes."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"parameters":[{"id":1492,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1493,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},"implementationOf":{"type":"reference","target":1378,"name":"Runnable.run"}}],"implementationOf":{"type":"reference","target":1378,"name":"Runnable.run"}},{"id":1494,"name":"skip","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"signatures":[{"id":1495,"name":"skip","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mark a task as skipped if the condition is true."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"parameters":[{"id":1496,"name":"condition","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true"}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[1454]},{"title":"Properties","children":[1462,1463,1465,1469,1470,1471,1472,1497,1464,1466,1467,1468,1473]},{"title":"Accessors","children":[1476]},{"title":"Methods","children":[1504,1498,1478,1480,1482,1484,1486,1488,1490,1494]}],"categories":[{"title":"Events","children":[1469,1470,1471,1472]},{"title":"__CATEGORY__","children":[1454,1462,1463,1465,1497,1464,1466,1467,1468,1473,1476,1504,1498,1478,1480,1482,1484,1486,1488,1490,1494]}],"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":14,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L14"}],"typeParameters":[{"id":1508,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1509,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1510,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}],"extendedBy":[{"type":"reference","target":1135,"name":"Routine"},{"type":"reference","target":1300,"name":"Task"}],"implementedTypes":[{"type":"reference","target":1377,"typeArguments":[{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true},{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}],"name":"Runnable","package":"@boost/pipeline"},{"type":"reference","target":1373,"name":"Hierarchical","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/WorkUnit","previousId":1390,"nextId":1369},{"id":1369,"name":"AggregatedResult","variant":"declaration","kind":256,"flags":{},"children":[{"id":1370,"name":"errors","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of "},{"kind":"code","text":"`Errors`"},{"kind":"text","text":" that occurred during execution."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L13"}],"type":{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}},{"id":1371,"name":"results","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of successful execution results."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L15"}],"type":{"type":"array","elementType":{"type":"reference","target":1372,"name":"T","package":"@boost/pipeline","qualifiedName":"AggregatedResult.T","refersToTypeParameter":true}}}],"groups":[{"title":"Properties","children":[1370,1371]}],"sources":[{"fileName":"packages/pipeline/src/types.ts","line":11,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L11"}],"typeParameters":[{"id":1372,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/pipeline/interface/AggregatedResult","previousId":1453,"nextId":1129},{"id":1129,"name":"ExecuteCommandOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1134,"name":"workUnit","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L21"}],"type":{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"}},{"id":1130,"name":"wrap","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L20"}],"type":{"type":"reflection","declaration":{"id":1131,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":20,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L20"}],"signatures":[{"id":1132,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":20,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L20"}],"parameters":[{"id":1133,"name":"process","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"ExecaChildProcess"},"name":"ExecaChildProcess","package":"execa"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[1134,1130]}],"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":19,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L19"}],"permalink":"/api/pipeline/interface/ExecuteCommandOptions","previousId":1369,"nextId":1373},{"id":1373,"name":"Hierarchical","variant":"declaration","kind":256,"flags":{},"children":[{"id":1374,"name":"depth","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current depth of nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L20"}],"type":{"type":"intrinsic","name":"number"}},{"id":1375,"name":"id","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique ID of the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L22"}],"type":{"type":"intrinsic","name":"string"}},{"id":1376,"name":"index","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current index amongst sibling work units."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L24"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[1374,1375,1376]}],"sources":[{"fileName":"packages/pipeline/src/types.ts","line":18,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L18"}],"implementedBy":[{"type":"reference","target":1453,"name":"WorkUnit"}],"permalink":"/api/pipeline/interface/Hierarchical","previousId":1129,"nextId":1059},{"id":1059,"name":"PooledOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1060,"name":"concurrency","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"How many work units to process in parallel."}]},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"}},{"id":1061,"name":"filo","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Process with first-in-last-out order, instead of first-in-first-out."}]},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L17"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1062,"name":"timeout","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Timeout in milliseconds that each work unit may run, or "},{"kind":"code","text":"`0`"},{"kind":"text","text":" to avoid a\\ntimeout. Defaults to "},{"kind":"code","text":"`0`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L20"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[1060,1061,1062]}],"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":13,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L13"}],"permalink":"/api/pipeline/interface/PooledOptions","previousId":1373,"nextId":1377},{"id":1377,"name":"Runnable","variant":"declaration","kind":256,"flags":{},"children":[{"id":1378,"name":"run","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L29"}],"type":{"type":"reflection","declaration":{"id":1379,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":29,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L29"}],"signatures":[{"id":1380,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":29,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L29"}],"parameters":[{"id":1381,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1382,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1383,"name":"Input","package":"@boost/pipeline","qualifiedName":"Runnable.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1384,"name":"Output","package":"@boost/pipeline","qualifiedName":"Runnable.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]}}}],"groups":[{"title":"Properties","children":[1378]}],"sources":[{"fileName":"packages/pipeline/src/types.ts","line":27,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L27"}],"typeParameters":[{"id":1383,"name":"Input","variant":"typeParam","kind":131072,"flags":{}},{"id":1384,"name":"Output","variant":"typeParam","kind":131072,"flags":{}}],"implementedBy":[{"type":"reference","target":1453,"name":"WorkUnit"}],"permalink":"/api/pipeline/interface/Runnable","previousId":1059,"nextId":1360},{"id":1360,"name":"Action","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L5"}],"typeParameters":[{"id":1366,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1367,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1368,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1367,"name":"Input","package":"@boost/pipeline","refersToTypeParameter":true}}],"type":{"type":"reflection","declaration":{"id":1361,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":5,"character":75,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L5"}],"signatures":[{"id":1362,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":1363,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1366,"name":"Ctx","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1364,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1367,"name":"Input","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1365,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"}}],"type":{"type":"union","types":[{"type":"reference","target":1368,"name":"Output","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1368,"name":"Output","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}]}}]}},"permalink":"/api/pipeline#Action","previousId":1377,"nextId":1386},{"id":1386,"name":"AnyPipeline","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":36,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/pipeline/src/Pipeline.ts","qualifiedName":"Pipeline"},"typeArguments":[{"type":"reflection","declaration":{"id":1387,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":36,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L36"}]}},{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"Pipeline","package":"@boost/pipeline"},"permalink":"/api/pipeline#AnyPipeline","previousId":1360,"nextId":1388},{"id":1388,"name":"AnyWorkUnit","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":40,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L40"}],"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1389,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":40,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L40"}]}},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"WorkUnit","package":"@boost/pipeline"},"permalink":"/api/pipeline#AnyWorkUnit","previousId":1386,"nextId":1053},{"id":1053,"name":"PipelineErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/PipelineError.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PipelineError.ts#L11"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/pipeline/src/PipelineError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/pipeline","preferValues":true}}},"permalink":"/api/pipeline#PipelineErrorCode","previousId":1388,"nextId":1385},{"id":1385,"name":"Status","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":32,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L32"}],"type":{"type":"union","types":[{"type":"literal","value":"failed"},{"type":"literal","value":"passed"},{"type":"literal","value":"pending"},{"type":"literal","value":"running"},{"type":"literal","value":"skipped"}]},"permalink":"/api/pipeline#Status","previousId":1053,"nextId":1054},{"id":1054,"name":"PipelineError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/PipelineError.ts","line":13,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PipelineError.ts#L13"}],"type":{"type":"reflection","declaration":{"id":1055,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":1056,"name":"new PipelineError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":1057,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"ACTION_REQUIRED"},{"type":"literal","value":"ROUTINE_INVALID_KEY"},{"type":"literal","value":"WORK_REQUIRED_TITLE"},{"type":"literal","value":"WORK_TIME_OUT"},{"type":"literal","value":"WORK_UNKNOWN"}]}},{"id":1058,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"ACTION_REQUIRED"},{"type":"literal","value":"ROUTINE_INVALID_KEY"},{"type":"literal","value":"WORK_REQUIRED_TITLE"},{"type":"literal","value":"WORK_TIME_OUT"},{"type":"literal","value":"WORK_UNKNOWN"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/pipeline#PipelineError","previousId":1385,"nextId":976},{"id":976,"name":"STATUS_FAILED","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L7"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'failed\'","permalink":"/api/pipeline#STATUS_FAILED","previousId":1054,"nextId":975},{"id":975,"name":"STATUS_PASSED","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L6"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'passed\'","permalink":"/api/pipeline#STATUS_PASSED","previousId":976,"nextId":972},{"id":972,"name":"STATUS_PENDING","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L3"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'pending\'","permalink":"/api/pipeline#STATUS_PENDING","previousId":975,"nextId":973},{"id":973,"name":"STATUS_RUNNING","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L4"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'running\'","permalink":"/api/pipeline#STATUS_RUNNING","previousId":972,"nextId":974},{"id":974,"name":"STATUS_SKIPPED","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":5,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L5"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'skipped\'","permalink":"/api/pipeline#STATUS_SKIPPED","previousId":973}],"groups":[{"title":"Classes","children":[848,910,977,983,996,1063,1135,1243,1300,1390,1453]},{"title":"Interfaces","children":[1369,1129,1373,1059,1377]},{"title":"Type Aliases","children":[1360,1386,1388,1053,1385]},{"title":"Variables","children":[1054,976,975,972,973,974]}],"sources":[{"fileName":"packages/pipeline/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/index.ts#L1"}],"permalink":"/api/pipeline"},"urlSlug":"pipeline"}],"packageName":"@boost/pipeline","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":6,"name":"@boost/plugin","variant":"declaration","kind":2,"flags":{},"children":[{"id":1512,"name":"Plugin","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1513,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":6,"character":4}],"signatures":[{"id":1514,"name":"new Plugin","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":6,"character":4}],"typeParameter":[{"id":1515,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1516,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1517,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":1518,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1512,"typeArguments":[{"type":"reference","target":1515,"name":"T","package":"@boost/plugin","qualifiedName":"Plugin.T","refersToTypeParameter":true},{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Plugin","package":"@boost/plugin"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":1519,"name":"name","variant":"declaration","kind":1024,"flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Unique name of the plugin. Typically the npm package name."}]},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":8,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L8"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":1633,"name":"Pluggable.name"}},{"id":1526,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":1533,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"signatures":[{"id":1534,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"parameters":[{"id":1535,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":1536,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":1527,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1528,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1529,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1530,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1531,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1532,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":1523,"name":"shutdown","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Life cycle called when the plugin is unregistered."}]},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L12"}],"signatures":[{"id":1524,"name":"shutdown","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L12"}],"parameters":[{"id":1525,"name":"tool","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1515,"name":"T","package":"@boost/plugin","qualifiedName":"Plugin.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"},"implementationOf":{"type":"reference","target":-1,"name":"Pluggable.shutdown"}}],"implementationOf":{"type":"reference","target":1635,"name":"Pluggable.shutdown"}},{"id":1520,"name":"startup","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Life cycle called when the plugin is registered."}]},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L10"}],"signatures":[{"id":1521,"name":"startup","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L10"}],"parameters":[{"id":1522,"name":"tool","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1515,"name":"T","package":"@boost/plugin","qualifiedName":"Plugin.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"},"implementationOf":{"type":"reference","target":-1,"name":"Pluggable.startup"}}],"implementationOf":{"type":"reference","target":1636,"name":"Pluggable.startup"}}],"groups":[{"title":"Constructors","children":[1513]},{"title":"Properties","children":[1519,1526]},{"title":"Methods","children":[1533,1527,1523,1520]}],"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":4,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L4"}],"typeParameters":[{"id":1537,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1538,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1539,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":4,"character":67,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L4"}]}}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}],"implementedTypes":[{"type":"reference","target":1632,"typeArguments":[{"type":"reference","target":1515,"name":"T","package":"@boost/plugin","qualifiedName":"Plugin.T","refersToTypeParameter":true}],"name":"Pluggable","package":"@boost/plugin"}],"permalink":"/api/plugin/class/Plugin","nextId":1546},{"id":1546,"name":"Registry","variant":"declaration","kind":128,"flags":{},"children":[{"id":1547,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":75,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L75"}],"signatures":[{"id":1548,"name":"new Registry","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":75,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L75"}],"typeParameter":[{"id":1549,"name":"Plugin","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Pluggable","package":"@boost/plugin"}},{"id":1550,"name":"Tool","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":1551,"name":"projectName","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1552,"name":"typeName","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1553,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}}],"type":{"type":"reference","target":1546,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true},{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}],"name":"Registry","package":"@boost/plugin"},"overwrites":{"type":"reference","target":-1,"name":"Contract<\\n\\tRegistryOptions\\n>.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract<\\n\\tRegistryOptions\\n>.constructor"}},{"id":1554,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":33,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L33"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"}},{"id":1555,"name":"onAfterRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a plugin is registered."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":39,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L39"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1556,"name":"onAfterUnregister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a plugin is unregistered."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":45,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L45"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1557,"name":"onBeforeRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a plugin is registered and the "},{"kind":"code","text":"`startup`"},{"kind":"text","text":" life-cycle."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L51"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1558,"name":"onBeforeUnregister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a plugin is unregistered and the "},{"kind":"code","text":"`shutdown`"},{"kind":"text","text":" life-cycle."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":57,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L57"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1559,"name":"onLoad","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a plugin is loaded but before it\'s registered."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":63,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L63"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"object"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1615,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":1560,"name":"pluralName","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L65"}],"type":{"type":"intrinsic","name":"string"}},{"id":1561,"name":"projectName","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":67,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L67"}],"type":{"type":"intrinsic","name":"string"}},{"id":1562,"name":"singularName","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":69,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L69"}],"type":{"type":"intrinsic","name":"string"}},{"id":1565,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":89,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L89"}],"signatures":[{"id":1566,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":89,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L89"}],"parameters":[{"id":1567,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":1616,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1617,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1618,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1619,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1620,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1621,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":1568,"name":"formatModuleName","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":106,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L106"}],"signatures":[{"id":1569,"name":"formatModuleName","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format a name into a fully qualified and compatible Node/npm module name,\\nwith the tool and type names being used as scopes and prefixes."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":106,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L106"}],"parameters":[{"id":1570,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1571,"name":"scoped","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":1572,"name":"get","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L118"}],"signatures":[{"id":1573,"name":"get","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a single registered plugin by module name. If the plugin cannot be found,\\nan error will be thrown."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L118"}],"typeParameter":[{"id":1574,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Pluggable","package":"@boost/plugin"},"default":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}}],"parameters":[{"id":1575,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":1574,"name":"T","package":"@boost/plugin","refersToTypeParameter":true}}]},{"id":1576,"name":"getAll","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":131,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L131"}],"signatures":[{"id":1577,"name":"getAll","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return all registered plugins."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":131,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L131"}],"type":{"type":"array","elementType":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}}}]},{"id":1578,"name":"getMany","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":138,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L138"}],"signatures":[{"id":1579,"name":"getMany","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return multiple registered plugins by module name."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":138,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L138"}],"parameters":[{"id":1580,"name":"names","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"array","elementType":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}}}]},{"id":1590,"name":"isRegistered","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":214,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L214"}],"signatures":[{"id":1591,"name":"isRegistered","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if a plugin has been registered."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":214,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L214"}],"parameters":[{"id":1592,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1581,"name":"load","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":145,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L145"}],"signatures":[{"id":1582,"name":"load","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Load and register a single plugin by name, or with an explicit instance."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":145,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L145"}],"parameters":[{"id":1583,"name":"source","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]}},{"id":1584,"name":"params","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"object"},"defaultValue":"{}"},{"id":1585,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1645,"typeArguments":[{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}],"name":"RegisterOptions","package":"@boost/plugin"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]},{"id":1586,"name":"loadMany","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":182,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L182"}],"signatures":[{"id":1587,"name":"loadMany","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Load and register multiple plugins based on a list of settings."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":182,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L182"}],"parameters":[{"id":1588,"name":"settings","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":1638,"name":"Setting","package":"@boost/plugin"},{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true},{"type":"reference","target":1626,"name":"SourceWithOptions","package":"@boost/plugin"}]}}]}},{"id":1589,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1645,"typeArguments":[{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}],"name":"RegisterOptions","package":"@boost/plugin"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}}],"name":"Promise","package":"typescript"}}]},{"id":1593,"name":"register","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":227,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L227"}],"signatures":[{"id":1594,"name":"register","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a plugin and trigger startup with the provided tool."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":227,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L227"}],"parameters":[{"id":1595,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1596,"name":"plugin","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}},{"id":1597,"name":"tool","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}]},"defaultValue":"undefined"},{"id":1598,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1645,"typeArguments":[{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}],"name":"RegisterOptions","package":"@boost/plugin"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]},{"id":1599,"name":"unregister","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":271,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L271"}],"signatures":[{"id":1600,"name":"unregister","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unregister a plugin by name and trigger shutdown process."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":271,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L271"}],"parameters":[{"id":1601,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1602,"name":"tool","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[1547]},{"title":"Properties","children":[1554,1555,1556,1557,1558,1559,1615,1560,1561,1562]},{"title":"Methods","children":[1565,1616,1568,1572,1576,1578,1590,1581,1586,1593,1599]}],"categories":[{"title":"Events","children":[1555,1556,1557,1558,1559]},{"title":"__CATEGORY__","children":[1547,1554,1615,1560,1561,1562,1565,1616,1568,1572,1576,1578,1590,1581,1586,1593,1599]}],"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":30,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L30"}],"typeParameters":[{"id":1622,"name":"Plugin","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"name":"Pluggable","package":"@boost/plugin"}},{"id":1623,"name":"Tool","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Contract","package":"@boost/common"}],"permalink":"/api/plugin/class/Registry","previousId":1512,"nextId":1632},{"id":1632,"name":"Pluggable","variant":"declaration","kind":256,"flags":{},"children":[{"id":1633,"name":"name","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Unique name of the plugin. Typically the npm package name."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":15,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"string"}},{"id":1634,"name":"priority","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Priority in which to order the plugin."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L17"}],"type":{"type":"intrinsic","name":"number"}},{"id":1635,"name":"shutdown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Life cycle called when the plugin is unregistered."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L19"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1637,"name":"T","package":"@boost/plugin","qualifiedName":"Pluggable.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1636,"name":"startup","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Life cycle called when the plugin is registered."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L21"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1637,"name":"T","package":"@boost/plugin","qualifiedName":"Pluggable.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}}],"groups":[{"title":"Properties","children":[1633,1634,1635,1636]}],"sources":[{"fileName":"packages/plugin/src/types.ts","line":13,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L13"}],"typeParameters":[{"id":1637,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"any"}}],"implementedBy":[{"type":"reference","target":1512,"name":"Plugin"}],"permalink":"/api/plugin/interface/Pluggable","previousId":1546,"nextId":1645},{"id":1645,"name":"RegisterOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1646,"name":"priority","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Override the priority of the plugin."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L32"}],"type":{"type":"intrinsic","name":"number"}},{"id":1647,"name":"tool","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom tool instance to pass to life cycles."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L34"}],"type":{"type":"reference","target":1648,"name":"T","package":"@boost/plugin","qualifiedName":"RegisterOptions.T","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[1646,1647]}],"sources":[{"fileName":"packages/plugin/src/types.ts","line":30,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L30"}],"typeParameters":[{"id":1648,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"extendedBy":[{"type":"reference","target":1649,"name":"Registration"}],"permalink":"/api/plugin/interface/RegisterOptions","previousId":1632,"nextId":1649},{"id":1649,"name":"Registration","variant":"declaration","kind":256,"flags":{},"children":[{"id":1650,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique name of the plugin."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":39,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L39"}],"type":{"type":"intrinsic","name":"string"}},{"id":1651,"name":"plugin","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Plugin instance or object."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":41,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L41"}],"type":{"type":"reference","target":1654,"name":"T","package":"@boost/plugin","qualifiedName":"Registration.T","refersToTypeParameter":true}},{"id":1652,"name":"priority","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Override the priority of the plugin."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L32"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":1646,"name":"RegisterOptions.priority"}},{"id":1653,"name":"tool","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom tool instance to pass to life cycles."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L34"}],"type":{"type":"intrinsic","name":"unknown"},"inheritedFrom":{"type":"reference","target":1647,"name":"RegisterOptions.tool"}}],"groups":[{"title":"Properties","children":[1650,1651,1652,1653]}],"sources":[{"fileName":"packages/plugin/src/types.ts","line":37,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L37"}],"typeParameters":[{"id":1654,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"name":"Pluggable","package":"@boost/plugin"}}],"extendedTypes":[{"type":"reference","target":1645,"name":"RegisterOptions","package":"@boost/plugin"}],"permalink":"/api/plugin/interface/Registration","previousId":1645,"nextId":1655},{"id":1655,"name":"RegistryOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1656,"name":"afterShutdown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback fired after a plugin\'s "},{"kind":"code","text":"`shutdown`"},{"kind":"text","text":" life cycle is executed."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":46,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L46"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1657,"name":"afterStartup","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback fired after a plugin\'s "},{"kind":"code","text":"`startup`"},{"kind":"text","text":" life cycle is executed."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L48"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1658,"name":"beforeShutdown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback fired before a plugin\'s "},{"kind":"code","text":"`shutdown`"},{"kind":"text","text":" life cycle is executed."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L50"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1659,"name":"beforeStartup","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback fired before a plugin\'s "},{"kind":"code","text":"`startup`"},{"kind":"text","text":" life cycle is executed."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":52,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L52"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1660,"name":"resolver","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom module resolver."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":54,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L54"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"ModuleResolver"},"name":"ModuleResolver","package":"@boost/common"}},{"id":1661,"name":"validate","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Validate the shape of the plugin being registered."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":56,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L56"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}}],"groups":[{"title":"Properties","children":[1656,1657,1658,1659,1660,1661]}],"sources":[{"fileName":"packages/plugin/src/types.ts","line":44,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L44"}],"typeParameters":[{"id":1662,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"name":"Pluggable","package":"@boost/plugin"}}],"permalink":"/api/plugin/interface/RegistryOptions","previousId":1649,"nextId":1627},{"id":1627,"name":"Callback","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":9,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L9"}],"typeParameters":[{"id":1631,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reflection","declaration":{"id":1628,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":9,"character":36,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L9"}],"signatures":[{"id":1629,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":1630,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1631,"name":"T","package":"@boost/plugin","refersToTypeParameter":true}}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"},{"type":"intrinsic","name":"void"}]}}]}},"permalink":"/api/plugin#Callback","previousId":1655,"nextId":1639},{"id":1639,"name":"Factory","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":26,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L26"}],"typeParameters":[{"id":1643,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"name":"Pluggable","package":"@boost/plugin"}},{"id":1644,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"intrinsic","name":"object"}}],"type":{"type":"reflection","declaration":{"id":1640,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":26,"character":70,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L26"}],"signatures":[{"id":1641,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":1642,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1644,"name":"O","package":"@boost/plugin","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1643,"name":"T","package":"@boost/plugin","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},{"type":"reference","target":1643,"name":"T","package":"@boost/plugin","refersToTypeParameter":true}]}}]}},"permalink":"/api/plugin#Factory","previousId":1627,"nextId":1540},{"id":1540,"name":"PluginErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/PluginError.ts","line":13,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/PluginError.ts#L13"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/plugin/src/PluginError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/plugin","preferValues":true}}},"permalink":"/api/plugin#PluginErrorCode","previousId":1639,"nextId":1638},{"id":1638,"name":"Setting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":24,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L24"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":1625,"name":"SourceOptions","package":"@boost/plugin"}],"name":"Record","package":"typescript"},"permalink":"/api/plugin#Setting","previousId":1540,"nextId":1624},{"id":1624,"name":"Source","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L3"}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"FilePath"},"name":"FilePath","package":"@boost/common"},{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"ModuleID"},"name":"ModuleID","package":"@boost/common"}]},"permalink":"/api/plugin#Source","previousId":1638,"nextId":1625},{"id":1625,"name":"SourceOptions","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L5"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"object"}]},"permalink":"/api/plugin#SourceOptions","previousId":1624,"nextId":1626},{"id":1626,"name":"SourceWithOptions","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":7,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L7"}],"type":{"type":"tuple","elements":[{"type":"reference","target":1624,"name":"Source","package":"@boost/plugin"},{"type":"reference","target":1625,"name":"SourceOptions","package":"@boost/plugin"}]},"permalink":"/api/plugin#SourceWithOptions","previousId":1625,"nextId":1511},{"id":1511,"name":"DEFAULT_PRIORITY","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/plugin/src/constants.ts","line":1,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/constants.ts#L1"}],"type":{"type":"literal","value":100},"defaultValue":"100","permalink":"/api/plugin#DEFAULT_PRIORITY","previousId":1626,"nextId":1541},{"id":1541,"name":"PluginError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/plugin/src/PluginError.ts","line":15,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/PluginError.ts#L15"}],"type":{"type":"reflection","declaration":{"id":1542,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":1543,"name":"new PluginError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":1544,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"FACTORY_REQUIRED"},{"type":"literal","value":"MODULE_NAME_INVALID"},{"type":"literal","value":"MODULE_UNKNOWN_FORMAT"},{"type":"literal","value":"PLUGIN_REQUIRED"},{"type":"literal","value":"PLUGIN_REQUIRED_NAME"},{"type":"literal","value":"REGISTER_REQUIRED"},{"type":"literal","value":"SETTING_UNKNOWN"}]}},{"id":1545,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"FACTORY_REQUIRED"},{"type":"literal","value":"MODULE_NAME_INVALID"},{"type":"literal","value":"MODULE_UNKNOWN_FORMAT"},{"type":"literal","value":"PLUGIN_REQUIRED"},{"type":"literal","value":"PLUGIN_REQUIRED_NAME"},{"type":"literal","value":"REGISTER_REQUIRED"},{"type":"literal","value":"SETTING_UNKNOWN"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/plugin#PluginError","previousId":1511}],"groups":[{"title":"Classes","children":[1512,1546]},{"title":"Interfaces","children":[1632,1645,1649,1655]},{"title":"Type Aliases","children":[1627,1639,1540,1638,1624,1625,1626]},{"title":"Variables","children":[1511,1541]}],"sources":[{"fileName":"packages/plugin/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/index.ts#L1"}],"permalink":"/api/plugin"},"urlSlug":"plugin"}],"packageName":"@boost/plugin","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":7,"name":"@boost/terminal","variant":"declaration","kind":2,"flags":{},"children":[{"id":1663,"name":"cursor","variant":"declaration","kind":4,"flags":{},"children":[{"id":1673,"name":"hide","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Hide the cursor."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":13,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L13"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorHide","permalink":"/api/terminal/namespace/cursor#hide"},{"id":1674,"name":"nextLine","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Move cursor to the next line."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":16,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L16"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorNextLine","permalink":"/api/terminal/namespace/cursor#nextLine"},{"id":1675,"name":"position","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Return the current cursur position."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":19,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L19"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorGetPosition","permalink":"/api/terminal/namespace/cursor#position"},{"id":1676,"name":"prevLine","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Move cursor to the previous line."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":22,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L22"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorPrevLine","permalink":"/api/terminal/namespace/cursor#prevLine"},{"id":1677,"name":"restorePosition","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Restores the cursor position/state."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":25,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L25"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorRestorePosition","permalink":"/api/terminal/namespace/cursor#restorePosition"},{"id":1678,"name":"savePosition","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Saves the cursor position/state."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":28,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L28"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorSavePosition","permalink":"/api/terminal/namespace/cursor#savePosition"},{"id":1679,"name":"show","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Show the cursor."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":31,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L31"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorShow","permalink":"/api/terminal/namespace/cursor#show"},{"id":1680,"name":"startLine","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Move cursor to the start of the current line."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":34,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L34"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorLeft","permalink":"/api/terminal/namespace/cursor#startLine"},{"id":1664,"name":"backward","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L4"}],"signatures":[{"id":1665,"name":"backward","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of columns to move backward. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L4"}],"parameters":[{"id":1666,"name":"count","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#backward"},{"id":1667,"name":"down","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L7"}],"signatures":[{"id":1668,"name":"down","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of rows to move down. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L7"}],"parameters":[{"id":1669,"name":"count","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#down"},{"id":1670,"name":"forward","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L10"}],"signatures":[{"id":1671,"name":"forward","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of columns to move forward. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L10"}],"parameters":[{"id":1672,"name":"count","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#forward"},{"id":1681,"name":"to","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L37"}],"signatures":[{"id":1682,"name":"to","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set the relative position of the cursor."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L37"}],"parameters":[{"id":1683,"name":"x","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1684,"name":"y","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#to"},{"id":1685,"name":"toAbsolute","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":40,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L40"}],"signatures":[{"id":1686,"name":"toAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set the absolute position of the cursor, starting from the top left."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":40,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L40"}],"parameters":[{"id":1687,"name":"x","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1688,"name":"y","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#toAbsolute"},{"id":1689,"name":"up","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":43,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L43"}],"signatures":[{"id":1690,"name":"up","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of rows to move up. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":43,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L43"}],"parameters":[{"id":1691,"name":"count","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#up"}],"groups":[{"title":"Variables","children":[1673,1674,1675,1676,1677,1678,1679,1680]},{"title":"Functions","children":[1664,1667,1670,1681,1685,1689]}],"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L1"}],"permalink":"/api/terminal/namespace/cursor","previousId":1742,"nextId":1692},{"id":1692,"name":"screen","variant":"declaration","kind":4,"flags":{},"children":[{"id":1693,"name":"clear","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Clear the terminal screen."}]},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":5,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L5"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.clearScreen","permalink":"/api/terminal/namespace/screen#clear"},{"id":1694,"name":"clearTerminal","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":8,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L8"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#clearTerminal"},{"id":1695,"name":"erase","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Erase the screen and move the cursor the top left position."}]},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L11"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.eraseScreen","permalink":"/api/terminal/namespace/screen#erase"},{"id":1696,"name":"eraseDown","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":14,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L14"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseDown"},{"id":1697,"name":"eraseEndLine","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":17,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L17"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseEndLine"},{"id":1698,"name":"eraseLine","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":20,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L20"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseLine"},{"id":1702,"name":"eraseStartLine","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":26,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L26"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseStartLine"},{"id":1703,"name":"eraseUp","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":29,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L29"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseUp"},{"id":1704,"name":"scrollDown","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":32,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L32"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#scrollDown"},{"id":1705,"name":"scrollUp","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":35,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L35"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#scrollUp"},{"id":1699,"name":"eraseLines","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":23,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L23"}],"signatures":[{"id":1700,"name":"eraseLines","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Erase from the current cursor position up the specified amount of rows."}]},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":23,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L23"}],"parameters":[{"id":1701,"name":"count","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Count of rows to erase."}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/screen#eraseLines"},{"id":1706,"name":"size","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":38,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L38"}],"signatures":[{"id":1707,"name":"size","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Reliably and accurately get the screen size (in "},{"kind":"code","text":"`columns`"},{"kind":"text","text":" and "},{"kind":"code","text":"`rows`"},{"kind":"text","text":")."}]},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":38,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L38"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/term-size/index.d.ts","qualifiedName":"TerminalSize"},"name":"TerminalSize","package":"term-size"}}],"permalink":"/api/terminal/namespace/screen#size"}],"groups":[{"title":"Variables","children":[1693,1694,1695,1696,1697,1698,1702,1703,1704,1705]},{"title":"Functions","children":[1699,1706]}],"sources":[{"fileName":"packages/terminal/src/screen.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L1"}],"permalink":"/api/terminal/namespace/screen","previousId":1663,"nextId":1741},{"id":1742,"name":"WrapOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1743,"name":"hard","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/terminal/src/text.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L123"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1744,"name":"trim","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/terminal/src/text.ts","line":124,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L124"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1745,"name":"wordWrap","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/terminal/src/text.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L125"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[1743,1744,1745]}],"sources":[{"fileName":"packages/terminal/src/text.ts","line":122,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L122"}],"permalink":"/api/terminal/interface/WrapOptions","previousId":1735,"nextId":1663},{"id":1741,"name":"TruncateOptions","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":105,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L105"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/cli-truncate/index.d.ts","qualifiedName":"Options"},"name":"CliTruncateOptions","package":"cli-truncate","qualifiedName":"Options"},"permalink":"/api/terminal#TruncateOptions","previousId":1692,"nextId":1740},{"id":1740,"name":"ANSI_REGEX","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Regular expression for matching ANSI escape codes."}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L11"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/terminal#ANSI_REGEX","previousId":1741},{"id":1708,"name":"annotate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L23"}],"signatures":[{"id":1709,"name":"annotate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to wrap a piece of text with a visual annotation _(iTerm only)_. If a terminal doe\\nnot support annotations, it will pass the text through.\\n\\n"},{"kind":"code","text":"```ts\\nimport { annotate } from \'@boost/terminal\';\\n\\nconst text = annotate(\'fileName.js\', absFilePath);\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L23"}],"parameters":[{"id":1710,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1711,"name":"annotation","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/annotate","nextId":1712},{"id":1712,"name":"calculateWidth","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":41,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L41"}],"signatures":[{"id":1713,"name":"calculateWidth","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Calculate and return the visual width of a string (number of terminal columns required).\\nBased on [string-width](https://www.npmjs.com/package/string-width).\\n\\n"},{"kind":"code","text":"```ts\\nimport { calculateWidth } from \'@boost/terminal\';\\n\\ncalculateWidth(\'\u53e4\'); // 2\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":41,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L41"}],"parameters":[{"id":1714,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"number"}}],"permalink":"/api/terminal/function/calculateWidth","previousId":1708,"nextId":1715},{"id":1715,"name":"hasAnsi","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":55,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L55"}],"signatures":[{"id":1716,"name":"hasAnsi","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns true if the string contains ANSI escape codes.\\nBased on [ansi-regex](https://www.npmjs.com/package/ansi-regex).\\n\\n"},{"kind":"code","text":"```ts\\nimport { hasAnsi } from \'@boost/terminal\';\\n\\nhasAnsi(\'\\\\u001B[4mTest\\\\u001B[0m\'); // true\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":55,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L55"}],"parameters":[{"id":1717,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/terminal/function/hasAnsi","previousId":1712,"nextId":1718},{"id":1718,"name":"link","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":69,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L69"}],"signatures":[{"id":1719,"name":"link","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to wrap a piece of text in an ANSI escape code hyperlink.\\nIf a terminal does not support hyperlinks, it will pass the text through.\\n\\n"},{"kind":"code","text":"```ts\\nimport { link } from \'@boost/terminal\';\\n\\nconst text = link(\'Read the manual\', \'https://boostlib.dev\');\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":69,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L69"}],"parameters":[{"id":1720,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1721,"name":"url","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/link","previousId":1715,"nextId":1722},{"id":1722,"name":"sliceAnsi","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":87,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L87"}],"signatures":[{"id":1723,"name":"sliceAnsi","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Slice a string while preserving ANSI escape codes.\\nBased on [slice-ansi](https://www.npmjs.com/package/slice-ansi).\\n\\n"},{"kind":"code","text":"```ts\\nimport { sliceAnsi } from \'@boost/terminal\';\\n\\nconst text = sliceAnsi(aStringThatMayContainAnsi, 15, 25);\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":87,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L87"}],"parameters":[{"id":1724,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1725,"name":"start","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1726,"name":"end","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/sliceAnsi","previousId":1718,"nextId":1727},{"id":1727,"name":"stripAnsi","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":101,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L101"}],"signatures":[{"id":1728,"name":"stripAnsi","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Strip all ANSI escape codes from the provided string.\\nBased on [strip-ansi](https://www.npmjs.com/package/strip-ansi).\\n\\n"},{"kind":"code","text":"```ts\\nimport { stripAnsi } from \'@boost/terminal\';\\n\\nconst text = stripAnsi(aStringThatContainsAnsi);\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":101,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L101"}],"parameters":[{"id":1729,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/stripAnsi","previousId":1722,"nextId":1730},{"id":1730,"name":"truncate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":118,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L118"}],"signatures":[{"id":1731,"name":"truncate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Truncate a string to a desired terminal width while preserving ANSI escape codes,\\nUnicode surrogate pairs, and fullwidth characters.\\nBased on [cli-truncate](https://www.npmjs.com/package/cli-truncate).\\n\\n"},{"kind":"code","text":"```ts\\nimport { truncate } from \'@boost/terminal\';\\n\\nconst text = truncate(aStringThatMayContainAnsi, 10, { position: \'middle\' });\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":118,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L118"}],"parameters":[{"id":1732,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1733,"name":"width","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1734,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/cli-truncate/index.d.ts","qualifiedName":"Options"},"name":"Options","package":"cli-truncate"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/truncate","previousId":1727,"nextId":1735},{"id":1735,"name":"wrapAnsi","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":138,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L138"}],"signatures":[{"id":1736,"name":"wrapAnsi","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Wrap a string that contains ANSI escape codes to a desired terminal width.\\nBased on [wrap-ansi](https://www.npmjs.com/package/wrap-ansi).\\n\\n"},{"kind":"code","text":"```ts\\nimport { wrapAnsi } from \'@boost/terminal\';\\n\\nconst text = wrapAnsi(aStringThatContainsAnsi, 20);\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":138,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L138"}],"parameters":[{"id":1737,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1738,"name":"width","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1739,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1742,"name":"WrapOptions","package":"@boost/terminal"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/wrapAnsi","previousId":1730,"nextId":1742}],"groups":[{"title":"Functions","children":[1708,1712,1715,1718,1722,1727,1730,1735]},{"title":"Interfaces","children":[1742]},{"title":"Namespaces","children":[1663,1692]},{"title":"Type Aliases","children":[1741]},{"title":"Variables","children":[1740]}],"sources":[{"fileName":"packages/terminal/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/index.ts#L1"}],"permalink":"/api/terminal"},"urlSlug":"terminal"}],"packageName":"@boost/terminal","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":8,"name":"@boost/translate","variant":"declaration","kind":2,"flags":{},"children":[{"id":1768,"name":"MessageOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1771,"name":"context","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Context used for special parsing (male, female, etc)."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L17"}],"type":{"type":"intrinsic","name":"string"}},{"id":1770,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Count used to determine plurals."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"number"}},{"id":1769,"name":"defaultValue","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Default value to return if a translation was not found."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L13"}],"type":{"type":"intrinsic","name":"string"}},{"id":1772,"name":"interpolation","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Interpolation options to pass down."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L19"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/i18next/typescript/options.d.ts","qualifiedName":"InterpolationOptions"},"name":"InterpolationOptions","package":"i18next"}},{"id":1773,"name":"locale","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Force translation to this locale."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L21"}],"type":{"type":"intrinsic","name":"string"}},{"id":1774,"name":"postProcess","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Post-processors to run on the translation."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L23"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"groups":[{"title":"Properties","children":[1771,1770,1769,1772,1773,1774]}],"sources":[{"fileName":"packages/translate/src/types.ts","line":11,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L11"}],"permalink":"/api/translate/interface/MessageOptions","previousId":1746,"nextId":1775},{"id":1775,"name":"Translator","variant":"declaration","kind":256,"flags":{},"children":[{"id":1778,"name":"changeLocale","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L30"}],"type":{"type":"reflection","declaration":{"id":1779,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":30,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L30"}],"signatures":[{"id":1780,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":30,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L30"}],"parameters":[{"id":1781,"name":"locale","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]}}},{"id":1776,"name":"direction","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L28"}],"type":{"type":"reference","target":1764,"name":"Direction","package":"@boost/translate"}},{"id":1777,"name":"locale","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L29"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[1778,1776,1777]}],"sources":[{"fileName":"packages/translate/src/types.ts","line":26,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L26"}],"signatures":[{"id":1783,"name":"Translator","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L27"}],"parameters":[{"id":1784,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":1785,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1767,"name":"InterpolationParams","package":"@boost/translate"}},{"id":1786,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1768,"name":"MessageOptions","package":"@boost/translate"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/translate/interface/Translator","previousId":1768,"nextId":1751},{"id":1751,"name":"TranslatorOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1752,"name":"autoDetect","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Automatically detect the locale from the environment. Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L11"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1753,"name":"debug","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Enable debugging by logging info to the console."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L13"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1754,"name":"fallbackLocale","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Fallback locale(s) to use when the detected locale isn\'t translated. Defaults to "},{"kind":"code","text":"`en`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L15"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":1755,"name":"locale","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Locale to explicitly use."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L17"}],"type":{"type":"intrinsic","name":"string"}},{"id":1756,"name":"lookupType","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Order in which to load and lookup locale translations."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L19"}],"type":{"type":"union","types":[{"type":"literal","value":"all"},{"type":"literal","value":"currentOnly"},{"type":"literal","value":"languageOnly"}]}},{"id":1757,"name":"resourceFormat","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"File format resource bundles are written in. Defaults to "},{"kind":"code","text":"`yaml`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L21"}],"type":{"type":"reference","target":1765,"name":"Format","package":"@boost/translate"}}],"groups":[{"title":"Properties","children":[1752,1753,1754,1755,1756,1757]}],"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":9,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L9"}],"permalink":"/api/translate/interface/TranslatorOptions","previousId":1775,"nextId":1764},{"id":1764,"name":"Direction","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L3"}],"type":{"type":"union","types":[{"type":"literal","value":"ltr"},{"type":"literal","value":"rtl"}]},"permalink":"/api/translate#Direction","previousId":1751,"nextId":1765},{"id":1765,"name":"Format","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L5"}],"type":{"type":"union","types":[{"type":"literal","value":"cjs"},{"type":"literal","value":"js"},{"type":"literal","value":"json"},{"type":"literal","value":"mjs"},{"type":"literal","value":"yaml"}]},"permalink":"/api/translate#Format","previousId":1764,"nextId":1767},{"id":1767,"name":"InterpolationParams","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":9,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L9"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript"},"permalink":"/api/translate#InterpolationParams","previousId":1765,"nextId":1766},{"id":1766,"name":"Locale","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":7,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L7"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/translate#Locale","previousId":1767,"nextId":1758},{"id":1758,"name":"TranslateErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/TranslateError.ts","line":10,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/TranslateError.ts#L10"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/translate/src/TranslateError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/translate","preferValues":true}}},"permalink":"/api/translate#TranslateErrorCode","previousId":1766,"nextId":1759},{"id":1759,"name":"TranslateError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/translate/src/TranslateError.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/TranslateError.ts#L12"}],"type":{"type":"reflection","declaration":{"id":1760,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":1761,"name":"new TranslateError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":1762,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"LOCALE_REQUIRED"},{"type":"literal","value":"NAMESPACE_REQUIRED"},{"type":"literal","value":"RESOURCE_PATH_INVALID"},{"type":"literal","value":"RESOURCES_REQUIRED"}]}},{"id":1763,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"LOCALE_REQUIRED"},{"type":"literal","value":"NAMESPACE_REQUIRED"},{"type":"literal","value":"RESOURCE_PATH_INVALID"},{"type":"literal","value":"RESOURCES_REQUIRED"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/translate#TranslateError","previousId":1758},{"id":1746,"name":"createTranslator","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":28,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L28"}],"signatures":[{"id":1747,"name":"createTranslator","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`Translator`"},{"kind":"text","text":" instance with the defined namespace.\\nA list of resource paths are required for locating translation files."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":28,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L28"}],"parameters":[{"id":1748,"name":"namespace","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":1749,"name":"resourcePath","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}]}},{"id":1750,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1751,"name":"TranslatorOptions","package":"@boost/translate"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1775,"name":"Translator","package":"@boost/translate"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/translate/function/createTranslator","nextId":1768}],"groups":[{"title":"Functions","children":[1746]},{"title":"Interfaces","children":[1768,1775,1751]},{"title":"Type Aliases","children":[1764,1765,1767,1766,1758]},{"title":"Variables","children":[1759]}],"sources":[{"fileName":"packages/translate/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/index.ts#L1"}],"permalink":"/api/translate"},"urlSlug":"translate"}],"packageName":"@boost/translate","packageVersion":"5.0.0-alpha.2"}]')}}]); \ No newline at end of file +"use strict";(self.webpackChunkwebsite=self.webpackChunkwebsite||[]).push([[8708],{3888:e=>{e.exports=JSON.parse('[{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":1,"name":"@boost/args","variant":"declaration","kind":2,"flags":{},"children":[{"id":147,"name":"ParseError","variant":"declaration","kind":128,"flags":{},"children":[{"id":148,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/args/src/ParseError.ts","line":6,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L6"}],"signatures":[{"id":149,"name":"new ParseError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/args/src/ParseError.ts","line":6,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L6"}],"parameters":[{"id":150,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":151,"name":"arg","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":152,"name":"index","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":147,"name":"ParseError","package":"@boost/args"},"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}},{"id":153,"name":"arg","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/src/ParseError.ts","line":2,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L2"}],"type":{"type":"intrinsic","name":"string"}},{"id":154,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/src/ParseError.ts","line":4,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L4"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","children":[148]},{"title":"Properties","children":[153,154]}],"sources":[{"fileName":"packages/args/src/ParseError.ts","line":1,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ParseError.ts#L1"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}],"permalink":"/api/args/class/ParseError","nextId":335},{"id":335,"name":"ValidationError","variant":"declaration","kind":128,"flags":{},"children":[{"id":336,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/args/src/ValidationError.ts","line":6,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ValidationError.ts#L6"}],"signatures":[{"id":337,"name":"new ValidationError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/args/src/ValidationError.ts","line":6,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ValidationError.ts#L6"}],"parameters":[{"id":338,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":339,"name":"option","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"}],"type":{"type":"reference","target":335,"name":"ValidationError","package":"@boost/args"},"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}},{"id":340,"name":"option","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/src/ValidationError.ts","line":4,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ValidationError.ts#L4"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Constructors","children":[336]},{"title":"Properties","children":[340]}],"sources":[{"fileName":"packages/args/src/ValidationError.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ValidationError.ts#L3"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}],"permalink":"/api/args/class/ValidationError","previousId":147,"nextId":137},{"id":225,"name":"Arg","variant":"declaration","kind":256,"flags":{},"children":[{"id":226,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L160"}],"type":{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}},{"id":236,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":214,"name":"Config.deprecated"}},{"id":237,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":215,"name":"Config.description"}},{"id":227,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":228,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":229,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":230,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}}]}}},{"id":238,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":216,"name":"Config.hidden"}},{"id":231,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"}},{"id":232,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":233,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":234,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":235,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":239,"name":"T","package":"@boost/args","qualifiedName":"Arg.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[226,236,237,227,238,231,232]}],"sources":[{"fileName":"packages/args/src/types.ts","line":150,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L150"}],"typeParameters":[{"id":239,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"extendedTypes":[{"type":"reference","target":213,"name":"Config","package":"@boost/args"}],"extendedBy":[{"type":"reference","target":240,"name":"Option"},{"type":"reference","target":303,"name":"Param"}],"permalink":"/api/args/interface/Arg","previousId":155,"nextId":191},{"id":191,"name":"Arguments","variant":"declaration","kind":256,"flags":{},"children":[{"id":192,"name":"command","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current running command and sub-commads. Is an array split on \\":\\"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L92"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":193,"name":"errors","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of errors detected during argument parsing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":94,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L94"}],"type":{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}},{"id":194,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of options to their values passed on the command line (or their default)."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":96,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L96"}],"type":{"type":"reference","target":198,"name":"O","package":"@boost/args","qualifiedName":"Arguments.O","refersToTypeParameter":true}},{"id":195,"name":"params","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of parameter values passed on the command line."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L98"}],"type":{"type":"reference","target":175,"typeArguments":[{"type":"reference","target":199,"name":"P","package":"@boost/args","qualifiedName":"Arguments.P","refersToTypeParameter":true}],"name":"MapParamType","package":"@boost/args"}},{"id":196,"name":"rest","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of arguments that appear after \\"--\\" on the command line."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":100,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L100"}],"type":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}},{"id":197,"name":"unknown","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of unconfigured options to string values."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":102,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L102"}],"type":{"type":"reference","target":169,"name":"UnknownOptionMap","package":"@boost/args"}}],"groups":[{"title":"Properties","children":[192,193,194,195,196,197]}],"sources":[{"fileName":"packages/args/src/types.ts","line":90,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L90"}],"typeParameters":[{"id":198,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":199,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}],"permalink":"/api/args/interface/Arguments","previousId":225,"nextId":320},{"id":320,"name":"Category","variant":"declaration","kind":256,"flags":{},"children":[{"id":321,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":205,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L205"}],"type":{"type":"intrinsic","name":"string"}},{"id":322,"name":"weight","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":206,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L206"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[321,322]}],"sources":[{"fileName":"packages/args/src/types.ts","line":204,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L204"}],"permalink":"/api/args/interface/Category","previousId":191,"nextId":217},{"id":217,"name":"Command","variant":"declaration","kind":256,"flags":{},"children":[{"id":218,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":137,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L137"}],"type":{"type":"intrinsic","name":"string"}},{"id":220,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":214,"name":"Config.deprecated"}},{"id":221,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":215,"name":"Config.description"}},{"id":222,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":216,"name":"Config.hidden"}},{"id":219,"name":"usage","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Define one or many usage examples to display in the help menu."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":139,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L139"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"groups":[{"title":"Properties","children":[218,220,221,222,219]}],"sources":[{"fileName":"packages/args/src/types.ts","line":135,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L135"}],"extendedTypes":[{"type":"reference","target":213,"name":"Config","package":"@boost/args"}],"permalink":"/api/args/interface/Command","previousId":320,"nextId":213},{"id":213,"name":"Config","variant":"declaration","kind":256,"flags":{},"children":[{"id":214,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":215,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"}},{"id":216,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[214,215,216]}],"sources":[{"fileName":"packages/args/src/types.ts","line":126,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L126"}],"extendedBy":[{"type":"reference","target":217,"name":"Command"},{"type":"reference","target":225,"name":"Arg"}],"permalink":"/api/args/interface/Config","previousId":217,"nextId":295},{"id":295,"name":"Flag","variant":"declaration","kind":256,"flags":{},"children":[{"id":297,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L171"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.category"}},{"id":296,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":193,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L193"}],"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","target":-1,"name":"Omit.default"}},{"id":300,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.deprecated"}},{"id":301,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.description"}},{"id":302,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.hidden"}},{"id":298,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":173,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L173"}],"type":{"type":"reference","target":334,"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.short"}},{"id":299,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"literal","value":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.type"}}],"groups":[{"title":"Properties","children":[297,296,300,301,302,298,299]}],"sources":[{"fileName":"packages/args/src/types.ts","line":192,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L192"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":240,"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Option","package":"@boost/args"},{"type":"union","types":[{"type":"literal","value":"format"},{"type":"literal","value":"validate"}]}],"name":"Omit","package":"typescript"}],"permalink":"/api/args/interface/Flag","previousId":213,"nextId":276},{"id":276,"name":"MultipleOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":277,"name":"arity","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error unless the list of values satisfy this required length."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":186,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L186"}],"type":{"type":"intrinsic","name":"number"}},{"id":280,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L171"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":241,"name":"Option.category"}},{"id":278,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":187,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L187"}],"type":{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true},"overwrites":{"type":"reference","target":243,"name":"Option.default"}},{"id":291,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":253,"name":"Option.deprecated"}},{"id":292,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":254,"name":"Option.description"}},{"id":282,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":283,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":284,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":285,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":244,"name":"Option.format"}},{"id":293,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":255,"name":"Option.hidden"}},{"id":279,"name":"multiple","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow multiple values to be passed."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":189,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L189"}],"type":{"type":"literal","value":true}},{"id":281,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":173,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L173"}],"type":{"type":"reference","target":334,"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":242,"name":"Option.short"}},{"id":286,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":248,"name":"Option.type"}},{"id":287,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":288,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":289,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":290,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":249,"name":"Option.validate"}}],"groups":[{"title":"Properties","children":[277,280,278,291,292,282,293,279,281,286,287]}],"sources":[{"fileName":"packages/args/src/types.ts","line":184,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L184"}],"typeParameters":[{"id":294,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":164,"name":"ListType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":240,"typeArguments":[{"type":"reference","target":294,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}],"name":"Option","package":"@boost/args"}],"permalink":"/api/args/interface/MultipleOption","previousId":295,"nextId":240},{"id":240,"name":"Option","variant":"declaration","kind":256,"flags":{},"children":[{"id":241,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L171"}],"type":{"type":"intrinsic","name":"string"}},{"id":243,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L160"}],"type":{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":226,"name":"Arg.default"}},{"id":253,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":236,"name":"Arg.deprecated"}},{"id":254,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":237,"name":"Arg.description"}},{"id":244,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":245,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":246,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":247,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":227,"name":"Arg.format"}},{"id":255,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":238,"name":"Arg.hidden"}},{"id":242,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":173,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L173"}],"type":{"type":"reference","target":334,"name":"ShortOptionName","package":"@boost/args"}},{"id":248,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":231,"name":"Arg.type"}},{"id":249,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":250,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":251,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":252,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":232,"name":"Arg.validate"}}],"groups":[{"title":"Properties","children":[241,243,253,254,244,255,242,248,249]}],"sources":[{"fileName":"packages/args/src/types.ts","line":169,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L169"}],"typeParameters":[{"id":256,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":167,"name":"ValueType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":225,"typeArguments":[{"type":"reference","target":256,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}],"name":"Arg","package":"@boost/args"}],"extendedBy":[{"type":"reference","target":257,"name":"SingleOption"},{"type":"reference","target":276,"name":"MultipleOption"}],"permalink":"/api/args/interface/Option","previousId":276,"nextId":303},{"id":303,"name":"Param","variant":"declaration","kind":256,"flags":{},"children":[{"id":306,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L160"}],"type":{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":226,"name":"Arg.default"}},{"id":316,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":236,"name":"Arg.deprecated"}},{"id":317,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":237,"name":"Arg.description"}},{"id":307,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":308,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":309,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":310,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":227,"name":"Arg.format"}},{"id":318,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":238,"name":"Arg.hidden"}},{"id":304,"name":"label","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Informational label to display in terminal output."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":198,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L198"}],"type":{"type":"intrinsic","name":"string"}},{"id":305,"name":"required","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the param is required or not. If required and not passed, the\\nparser will throw an error. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":201,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L201"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":311,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":231,"name":"Arg.type"}},{"id":312,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":313,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":314,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":315,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":232,"name":"Arg.validate"}}],"groups":[{"title":"Properties","children":[306,316,317,307,318,304,305,311,312]}],"sources":[{"fileName":"packages/args/src/types.ts","line":196,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L196"}],"typeParameters":[{"id":319,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":225,"typeArguments":[{"type":"reference","target":319,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}],"name":"Arg","package":"@boost/args"}],"permalink":"/api/args/interface/Param","previousId":240,"nextId":204},{"id":204,"name":"ParserOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":205,"name":"commands","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of valid commands. Sub-commands should be denoted with \\":\\"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L117"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"reference","target":181,"name":"CommandChecker","package":"@boost/args"}]}},{"id":208,"name":"loose","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Enable loose mode parsing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":107,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L107"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":201,"name":"ParserSettings.loose"}},{"id":206,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of options to their type and configurations."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L119"}],"type":{"type":"reference","target":179,"typeArguments":[{"type":"reference","target":211,"name":"O","package":"@boost/args","qualifiedName":"ParserOptions.O","refersToTypeParameter":true}],"name":"MapOptionConfig","package":"@boost/args"}},{"id":207,"name":"params","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of param configurations (in order)."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L121"}],"type":{"type":"reference","target":173,"typeArguments":[{"type":"reference","target":212,"name":"P","package":"@boost/args","qualifiedName":"ParserOptions.P","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}},{"id":209,"name":"unknown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be passed. Will be placed in a special "},{"kind":"code","text":"`unknown`"},{"kind":"text","text":" object."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":109,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L109"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":202,"name":"ParserSettings.unknown"}},{"id":210,"name":"variadic","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be passed. Will be accumlated after configured params."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":111,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L111"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":203,"name":"ParserSettings.variadic"}}],"groups":[{"title":"Properties","children":[205,208,206,207,209,210]}],"sources":[{"fileName":"packages/args/src/types.ts","line":114,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L114"}],"typeParameters":[{"id":211,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":212,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":200,"name":"ParserSettings","package":"@boost/args"}],"permalink":"/api/args/interface/ParserOptions","previousId":303,"nextId":200},{"id":200,"name":"ParserSettings","variant":"declaration","kind":256,"flags":{},"children":[{"id":201,"name":"loose","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Enable loose mode parsing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":107,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L107"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":202,"name":"unknown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be passed. Will be placed in a special "},{"kind":"code","text":"`unknown`"},{"kind":"text","text":" object."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":109,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L109"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":203,"name":"variadic","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be passed. Will be accumlated after configured params."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":111,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L111"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[201,202,203]}],"sources":[{"fileName":"packages/args/src/types.ts","line":105,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L105"}],"extendedBy":[{"type":"reference","target":204,"name":"ParserOptions"}],"permalink":"/api/args/interface/ParserSettings","previousId":204,"nextId":257},{"id":257,"name":"SingleOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":261,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L171"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":241,"name":"Option.category"}},{"id":258,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whitelist of acceptable values."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":178,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L178"}],"type":{"type":"array","elementType":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}},{"id":259,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"When found in an option group, increment the value for each occurrence. _(Numbers only)_"}]},"sources":[{"fileName":"packages/args/src/types.ts","line":180,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L180"}],"type":{"type":"conditional","checkType":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"number"},"trueType":{"type":"literal","value":true},"falseType":{"type":"intrinsic","name":"never"}}},{"id":260,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":181,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L181"}],"type":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true},"overwrites":{"type":"reference","target":243,"name":"Option.default"}},{"id":272,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L128"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":253,"name":"Option.deprecated"}},{"id":273,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L130"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":254,"name":"Option.description"}},{"id":263,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"type":{"type":"reflection","declaration":{"id":264,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"signatures":[{"id":265,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":162,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L162"}],"parameters":[{"id":266,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":244,"name":"Option.format"}},{"id":274,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L132"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":255,"name":"Option.hidden"}},{"id":262,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":173,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L173"}],"type":{"type":"reference","target":334,"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":242,"name":"Option.short"}},{"id":267,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L164"}],"type":{"type":"reference","target":223,"typeArguments":[{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":248,"name":"Option.type"}},{"id":268,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":269,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"signatures":[{"id":270,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":166,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L166"}],"parameters":[{"id":271,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":249,"name":"Option.validate"}}],"groups":[{"title":"Properties","children":[261,258,259,260,272,273,263,274,262,267,268]}],"sources":[{"fileName":"packages/args/src/types.ts","line":176,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L176"}],"typeParameters":[{"id":275,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":165,"name":"ScalarType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":240,"typeArguments":[{"type":"reference","target":275,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}],"name":"Option","package":"@boost/args"}],"permalink":"/api/args/interface/SingleOption","previousId":200,"nextId":170},{"id":170,"name":"AliasMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":19,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L19"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript"},"permalink":"/api/args#AliasMap","previousId":257,"nextId":163},{"id":163,"name":"ArgList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L5"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"permalink":"/api/args#ArgList","previousId":170,"nextId":123},{"id":123,"name":"ArgsErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/ArgsError.ts","line":35,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ArgsError.ts#L35"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/args/src/ArgsError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/args","preferValues":true}}},"permalink":"/api/args#ArgsErrorCode","previousId":163,"nextId":162},{"id":162,"name":"Argv","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L3"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"permalink":"/api/args#Argv","previousId":123,"nextId":181},{"id":181,"name":"CommandChecker","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":86,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L86"}],"type":{"type":"reflection","declaration":{"id":182,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":86,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L86"}],"signatures":[{"id":183,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":184,"name":"arg","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}]}},"permalink":"/api/args#CommandChecker","previousId":162,"nextId":185},{"id":185,"name":"ContextFactory","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":88,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L88"}],"type":{"type":"reflection","declaration":{"id":186,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":88,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L88"}],"signatures":[{"id":187,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":189,"name":"arg","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":190,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":162,"name":"Argv","package":"@boost/args"}}],"type":{"type":"union","types":[{"type":"reference","target":204,"typeArguments":[{"type":"reflection","declaration":{"id":188,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":88,"character":72,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L88"}]}}],"name":"ParserOptions","package":"@boost/args"},{"type":"intrinsic","name":"undefined"}]}}]}},"permalink":"/api/args#ContextFactory","previousId":181,"nextId":223},{"id":223,"name":"InferArgType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":144,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L144"}],"typeParameters":[{"id":224,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":224,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"boolean"},"trueType":{"type":"literal","value":"boolean"},"falseType":{"type":"conditional","checkType":{"type":"reference","target":224,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"intrinsic","name":"number"}]},"trueType":{"type":"literal","value":"number"},"falseType":{"type":"literal","value":"string"}}},"permalink":"/api/args#InferArgType","previousId":185,"nextId":177},{"id":177,"name":"InferOptionConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Determine option based on type."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":75,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L75"}],"typeParameters":[{"id":178,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"boolean"},"trueType":{"type":"reference","target":295,"name":"Flag","package":"@boost/args"},"falseType":{"type":"conditional","checkType":{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"trueType":{"type":"reference","target":276,"typeArguments":[{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true}],"name":"MultipleOption","package":"@boost/args"},"falseType":{"type":"conditional","checkType":{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"}]},"trueType":{"type":"reference","target":257,"typeArguments":[{"type":"reference","target":178,"name":"T","package":"@boost/args","refersToTypeParameter":true}],"name":"SingleOption","package":"@boost/args"},"falseType":{"type":"intrinsic","name":"never"}}}},"permalink":"/api/args#InferOptionConfig","previousId":223,"nextId":171},{"id":171,"name":"InferParamConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Determine option based on type. Only primitives are allowed."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":22,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L22"}],"typeParameters":[{"id":172,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":172,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"},"trueType":{"type":"reference","target":303,"typeArguments":[{"type":"reference","target":172,"name":"T","package":"@boost/args","refersToTypeParameter":true}],"name":"Param","package":"@boost/args"},"falseType":{"type":"intrinsic","name":"never"}},"permalink":"/api/args#InferParamConfig","previousId":177,"nextId":164},{"id":164,"name":"ListType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":7,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L7"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"permalink":"/api/args#ListType","previousId":171,"nextId":333},{"id":333,"name":"LongOptionName","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Option name without leading \\"--\\"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":226,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L226"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/args#LongOptionName","previousId":164,"nextId":179},{"id":179,"name":"MapOptionConfig","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":84,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L84"}],"typeParameters":[{"id":180,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"type":{"type":"mapped","parameter":"K","parameterType":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","target":180,"name":"T","package":"@boost/args","refersToTypeParameter":true}},"templateType":{"type":"reference","target":177,"typeArguments":[{"type":"indexedAccess","indexType":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"K"},"name":"K","package":"@boost/args","refersToTypeParameter":true},"objectType":{"type":"reference","target":180,"name":"T","package":"@boost/args","refersToTypeParameter":true}}],"name":"InferOptionConfig","package":"@boost/args"}},"permalink":"/api/args#MapOptionConfig","previousId":333,"nextId":173},{"id":173,"name":"MapParamConfig","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":26,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L26"}],"typeParameters":[{"id":174,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}}}],"type":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"},{"type":"inferred","name":"D"},{"type":"inferred","name":"E"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"D"},"name":"D","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"E"},"name":"E","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"},{"type":"inferred","name":"D"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"D"},"name":"D","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"},{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":171,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true}],"name":"InferParamConfig","package":"@boost/args"}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":174,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"},"trueType":{"type":"array","elementType":{"type":"reference","target":303,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Param","package":"@boost/args"}},"falseType":{"type":"intrinsic","name":"never"}}}}}}},"permalink":"/api/args#MapParamConfig","previousId":179,"nextId":175},{"id":175,"name":"MapParamType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":54,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L54"}],"typeParameters":[{"id":176,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}}}],"type":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"},{"type":"inferred","name":"D"},{"type":"inferred","name":"E"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"D"},"name":"D","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"E"},"name":"E","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"},{"type":"inferred","name":"D"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"D"},"name":"D","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"},{"type":"inferred","name":"C"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"C"},"name":"C","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"},{"type":"inferred","name":"B"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"B"},"name":"B","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A"}]},"trueType":{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"A"},"name":"A","package":"@boost/args","refersToTypeParameter":true},{"type":"rest","elementType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}]},"falseType":{"type":"conditional","checkType":{"type":"reference","target":176,"name":"T","package":"@boost/args","refersToTypeParameter":true},"extendsType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"},"trueType":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"},"falseType":{"type":"intrinsic","name":"never"}}}}}}},"permalink":"/api/args#MapParamType","previousId":173,"nextId":323},{"id":323,"name":"OptionConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Abstract type for easier typing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":210,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L210"}],"type":{"type":"intersection","types":[{"type":"reference","target":240,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Option","package":"@boost/args"},{"type":"reflection","declaration":{"id":324,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":325,"name":"arity","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":211,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L211"}],"type":{"type":"intrinsic","name":"number"}},{"id":326,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":212,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L212"}],"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}}},{"id":327,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":213,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L213"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":328,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":214,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L214"}],"type":{"type":"reference","target":167,"name":"ValueType","package":"@boost/args"}},{"id":329,"name":"multiple","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/src/types.ts","line":215,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L215"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[325,326,327,328,329]}],"sources":[{"fileName":"packages/args/src/types.ts","line":210,"character":41,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L210"}]}}]},"permalink":"/api/args#OptionConfig","previousId":175,"nextId":330},{"id":330,"name":"OptionConfigMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":218,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L218"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":323,"name":"OptionConfig","package":"@boost/args"}],"name":"Record","package":"typescript"},"permalink":"/api/args#OptionConfigMap","previousId":323,"nextId":168},{"id":168,"name":"OptionMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L15"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":167,"name":"ValueType","package":"@boost/args"}],"name":"Record","package":"typescript"},"permalink":"/api/args#OptionMap","previousId":330,"nextId":331},{"id":331,"name":"ParamConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Abstract type for easier typing."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":221,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L221"}],"type":{"type":"reference","target":303,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Param","package":"@boost/args"},"permalink":"/api/args#ParamConfig","previousId":168,"nextId":332},{"id":332,"name":"ParamConfigList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":223,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L223"}],"type":{"type":"array","elementType":{"type":"reference","target":331,"name":"ParamConfig","package":"@boost/args"}},"permalink":"/api/args#ParamConfigList","previousId":331,"nextId":166},{"id":166,"name":"PrimitiveType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L11"}],"type":{"type":"union","types":[{"type":"reference","target":165,"name":"ScalarType","package":"@boost/args"},{"type":"intrinsic","name":"boolean"}]},"permalink":"/api/args#PrimitiveType","previousId":332,"nextId":165},{"id":165,"name":"ScalarType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":9,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L9"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"}]},"permalink":"/api/args#ScalarType","previousId":166,"nextId":334},{"id":334,"name":"ShortOptionName","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Short option name without leading \\"-\\"."}]},"sources":[{"fileName":"packages/args/src/types.ts","line":229,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L229"}],"type":{"type":"union","types":[{"type":"literal","value":"A"},{"type":"literal","value":"a"},{"type":"literal","value":"B"},{"type":"literal","value":"b"},{"type":"literal","value":"C"},{"type":"literal","value":"c"},{"type":"literal","value":"D"},{"type":"literal","value":"d"},{"type":"literal","value":"E"},{"type":"literal","value":"e"},{"type":"literal","value":"F"},{"type":"literal","value":"f"},{"type":"literal","value":"G"},{"type":"literal","value":"g"},{"type":"literal","value":"H"},{"type":"literal","value":"h"},{"type":"literal","value":"I"},{"type":"literal","value":"i"},{"type":"literal","value":"J"},{"type":"literal","value":"j"},{"type":"literal","value":"K"},{"type":"literal","value":"k"},{"type":"literal","value":"L"},{"type":"literal","value":"l"},{"type":"literal","value":"M"},{"type":"literal","value":"m"},{"type":"literal","value":"N"},{"type":"literal","value":"n"},{"type":"literal","value":"O"},{"type":"literal","value":"o"},{"type":"literal","value":"P"},{"type":"literal","value":"p"},{"type":"literal","value":"Q"},{"type":"literal","value":"q"},{"type":"literal","value":"R"},{"type":"literal","value":"r"},{"type":"literal","value":"S"},{"type":"literal","value":"s"},{"type":"literal","value":"T"},{"type":"literal","value":"t"},{"type":"literal","value":"U"},{"type":"literal","value":"u"},{"type":"literal","value":"V"},{"type":"literal","value":"v"},{"type":"literal","value":"W"},{"type":"literal","value":"w"},{"type":"literal","value":"X"},{"type":"literal","value":"x"},{"type":"literal","value":"Y"},{"type":"literal","value":"y"},{"type":"literal","value":"Z"},{"type":"literal","value":"z"}]},"permalink":"/api/args#ShortOptionName","previousId":165,"nextId":169},{"id":169,"name":"UnknownOptionMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":17,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L17"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript"},"permalink":"/api/args#UnknownOptionMap","previousId":334,"nextId":167},{"id":167,"name":"ValueType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/src/types.ts","line":13,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/types.ts#L13"}],"type":{"type":"union","types":[{"type":"reference","target":164,"name":"ListType","package":"@boost/args"},{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}]},"permalink":"/api/args#ValueType","previousId":169,"nextId":124},{"id":124,"name":"ArgsError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/ArgsError.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/ArgsError.ts#L37"}],"type":{"type":"reflection","declaration":{"id":125,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":126,"name":"new ArgsError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":127,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"COMMAND_INVALID_FORMAT"},{"type":"literal","value":"COMMAND_NOT_FIRST"},{"type":"literal","value":"COMMAND_PROVIDED"},{"type":"literal","value":"CONTEXT_REQUIRED"},{"type":"literal","value":"GROUP_REQUIRED_COUNT"},{"type":"literal","value":"GROUP_UNSUPPORTED_TYPE"},{"type":"literal","value":"OPTION_INVALID_COUNT_TYPE"},{"type":"literal","value":"OPTION_UNKNOWN"},{"type":"literal","value":"OPTION_UNKNOWN_FORMAT"},{"type":"literal","value":"OPTION_UNKNOWN_MORE"},{"type":"literal","value":"PARAM_INVALID_ORDER"},{"type":"literal","value":"PARAM_REQUIRED"},{"type":"literal","value":"PARAM_REQUIRED_NO_DEFAULT"},{"type":"literal","value":"PARAM_UNKNOWN"},{"type":"literal","value":"SHORT_DEFINED"},{"type":"literal","value":"SHORT_INVALID_CHAR"},{"type":"literal","value":"SHORT_UNKNOWN"},{"type":"literal","value":"VALUE_INVALID_ARITY"},{"type":"literal","value":"VALUE_INVALID_CHOICE"},{"type":"literal","value":"VALUE_INVALID_FORMAT"},{"type":"literal","value":"VALUE_NO_INLINE"},{"type":"literal","value":"VALUE_NON_ARRAY"},{"type":"literal","value":"VALUE_NON_BOOL"},{"type":"literal","value":"VALUE_NON_NUMBER"},{"type":"literal","value":"VALUE_NON_STRING"}]}},{"id":128,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"COMMAND_INVALID_FORMAT"},{"type":"literal","value":"COMMAND_NOT_FIRST"},{"type":"literal","value":"COMMAND_PROVIDED"},{"type":"literal","value":"CONTEXT_REQUIRED"},{"type":"literal","value":"GROUP_REQUIRED_COUNT"},{"type":"literal","value":"GROUP_UNSUPPORTED_TYPE"},{"type":"literal","value":"OPTION_INVALID_COUNT_TYPE"},{"type":"literal","value":"OPTION_UNKNOWN"},{"type":"literal","value":"OPTION_UNKNOWN_FORMAT"},{"type":"literal","value":"OPTION_UNKNOWN_MORE"},{"type":"literal","value":"PARAM_INVALID_ORDER"},{"type":"literal","value":"PARAM_REQUIRED"},{"type":"literal","value":"PARAM_REQUIRED_NO_DEFAULT"},{"type":"literal","value":"PARAM_UNKNOWN"},{"type":"literal","value":"SHORT_DEFINED"},{"type":"literal","value":"SHORT_INVALID_CHAR"},{"type":"literal","value":"SHORT_UNKNOWN"},{"type":"literal","value":"VALUE_INVALID_ARITY"},{"type":"literal","value":"VALUE_INVALID_CHOICE"},{"type":"literal","value":"VALUE_INVALID_FORMAT"},{"type":"literal","value":"VALUE_NO_INLINE"},{"type":"literal","value":"VALUE_NON_ARRAY"},{"type":"literal","value":"VALUE_NON_BOOL"},{"type":"literal","value":"VALUE_NON_NUMBER"},{"type":"literal","value":"VALUE_NON_STRING"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/args#ArgsError","previousId":167,"nextId":132},{"id":132,"name":"COMMAND_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":8,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L8"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#COMMAND_FORMAT","previousId":124,"nextId":129},{"id":129,"name":"DEFAULT_BOOLEAN_VALUE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":2,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L2"}],"type":{"type":"literal","value":false},"defaultValue":"false","permalink":"/api/args#DEFAULT_BOOLEAN_VALUE","previousId":132,"nextId":130},{"id":130,"name":"DEFAULT_NUMBER_VALUE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L3"}],"type":{"type":"literal","value":0},"defaultValue":"0","permalink":"/api/args#DEFAULT_NUMBER_VALUE","previousId":129,"nextId":131},{"id":131,"name":"DEFAULT_STRING_VALUE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L4"}],"type":{"type":"literal","value":""},"defaultValue":"\'\'","permalink":"/api/args#DEFAULT_STRING_VALUE","previousId":130,"nextId":133},{"id":133,"name":"LONG_OPTION_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":13,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L13"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#LONG_OPTION_FORMAT","previousId":131,"nextId":136},{"id":136,"name":"OPTION_LIKE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":25,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L25"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#OPTION_LIKE","previousId":133,"nextId":134},{"id":134,"name":"SHORT_OPTION_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":17,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L17"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#SHORT_OPTION_FORMAT","previousId":136,"nextId":135},{"id":135,"name":"SHORT_OPTION_GROUP_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/args/src/constants.ts","line":21,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/constants.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/args#SHORT_OPTION_GROUP_FORMAT","previousId":134},{"id":137,"name":"format","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/args/src/format.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/format.ts#L14"}],"signatures":[{"id":138,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format a parsed arguments object back into a command line list of arguments."}]},"sources":[{"fileName":"packages/args/src/format.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/format.ts#L14"}],"parameters":[{"id":139,"name":"argument","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":191,"typeArguments":[{"type":"reference","target":168,"name":"OptionMap","package":"@boost/args"},{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}],"name":"Arguments","package":"@boost/args"}],"name":"Partial","package":"typescript"}}],"type":{"type":"reference","target":162,"name":"Argv","package":"@boost/args"}}],"permalink":"/api/args/function/format","previousId":335,"nextId":140},{"id":140,"name":"parse","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/args/src/parse.ts","line":59,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/parse.ts#L59"}],"signatures":[{"id":141,"name":"parse","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse a list of command line arguments (typically from "},{"kind":"code","text":"`process.argv`"},{"kind":"text","text":") into an arguments\\nobject. Will extract commands, options, flags, and params based on the defined parser options."}]},"sources":[{"fileName":"packages/args/src/parse.ts","line":59,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/parse.ts#L59"}],"typeParameter":[{"id":142,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":143,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}},{"id":144,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":145,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":162,"name":"Argv","package":"@boost/args"}},{"id":146,"name":"parserOptions","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":204,"typeArguments":[{"type":"reference","target":142,"name":"O","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":144,"name":"P","package":"@boost/args","refersToTypeParameter":true}],"name":"ParserOptions","package":"@boost/args"}}],"type":{"type":"reference","target":191,"typeArguments":[{"type":"reference","target":142,"name":"O","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":144,"name":"P","package":"@boost/args","refersToTypeParameter":true}],"name":"Arguments","package":"@boost/args"}}],"permalink":"/api/args/function/parse","previousId":137,"nextId":155},{"id":155,"name":"parseInContext","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/args/src/parseInContext.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/parseInContext.ts#L17"}],"signatures":[{"id":156,"name":"parseInContext","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse a list of command line arguments (typically from "},{"kind":"code","text":"`process.argv`"},{"kind":"text","text":") into an arguments\\nobject using a context factory. The factory can customize the parser options based on the\\narguments being parsed."}]},"sources":[{"fileName":"packages/args/src/parseInContext.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/parseInContext.ts#L17"}],"typeParameter":[{"id":157,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":158,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}},{"id":159,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":166,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":163,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":160,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":162,"name":"Argv","package":"@boost/args"}},{"id":161,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":185,"name":"ContextFactory","package":"@boost/args"}}],"type":{"type":"reference","target":191,"typeArguments":[{"type":"reference","target":157,"name":"O","package":"@boost/args","refersToTypeParameter":true},{"type":"reference","target":159,"name":"P","package":"@boost/args","refersToTypeParameter":true}],"name":"Arguments","package":"@boost/args"}}],"permalink":"/api/args/function/parseInContext","previousId":140,"nextId":225}],"groups":[{"title":"Classes","children":[147,335]},{"title":"Functions","children":[137,140,155]},{"title":"Interfaces","children":[225,191,320,217,213,295,276,240,303,204,200,257]},{"title":"Type Aliases","children":[170,163,123,162,181,185,223,177,171,164,333,179,173,175,323,330,168,331,332,166,165,334,169,167]},{"title":"Variables","children":[124,132,129,130,131,133,136,134,135]}],"sources":[{"fileName":"packages/args/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/args/src/index.ts#L1"}],"permalink":"/api/args"},"urlSlug":"args"}],"packageName":"@boost/args","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":9,"name":"@boost/cli","variant":"declaration","kind":2,"flags":{},"children":[{"id":1792,"name":"Arg","variant":"declaration","kind":4,"flags":{},"children":[{"id":1793,"name":"Flag","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Flag.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Flag.ts#L8"}],"signatures":[{"id":1794,"name":"Flag","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line flag (boolean value)."}]},"sources":[{"fileName":"packages/cli/src/decorators/Flag.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Flag.ts#L8"}],"parameters":[{"id":1795,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1796,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2148,"name":"Flag","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Flag"},{"id":1797,"name":"Number","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Number.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Number.ts#L8"}],"signatures":[{"id":1798,"name":"Number","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line option with a numeric value."}]},"sources":[{"fileName":"packages/cli/src/decorators/Number.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Number.ts#L8"}],"parameters":[{"id":1799,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1800,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2231,"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"SingleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Number"},{"id":1801,"name":"Numbers","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Numbers.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Numbers.ts#L8"}],"signatures":[{"id":1802,"name":"Numbers","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line option with multiple numeric values."}]},"sources":[{"fileName":"packages/cli/src/decorators/Numbers.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Numbers.ts#L8"}],"parameters":[{"id":1803,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1804,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2157,"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}}],"name":"MultipleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Numbers"},{"id":1805,"name":"Params","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Params.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Params.ts#L7"}],"signatures":[{"id":1806,"name":"Params","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator for declaring command line parameters (positional arguments)."}]},"sources":[{"fileName":"packages/cli/src/decorators/Params.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Params.ts#L7"}],"typeParameter":[{"id":1807,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"parameters":[{"id":1808,"name":"config","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":1807,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Params"},{"id":1809,"name":"String","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/String.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/String.ts#L8"}],"signatures":[{"id":1810,"name":"String","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line option with a string value."}]},"sources":[{"fileName":"packages/cli/src/decorators/String.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/String.ts#L8"}],"parameters":[{"id":1811,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1812,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2231,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SingleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#String"},{"id":1813,"name":"Strings","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Strings.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Strings.ts#L8"}],"signatures":[{"id":1814,"name":"Strings","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property decorator for declaring a command line option with multiple string values."}]},"sources":[{"fileName":"packages/cli/src/decorators/Strings.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Strings.ts#L8"}],"parameters":[{"id":1815,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1816,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2157,"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"MultipleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"PropertyDecorator"},"name":"PropertyDecorator","package":"typescript"}}],"permalink":"/api/cli/namespace/Arg#Strings"},{"id":1817,"name":"flag","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/flag.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/flag.ts#L8"}],"signatures":[{"id":1818,"name":"flag","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line flag (boolean value)."}]},"sources":[{"fileName":"packages/cli/src/initializers/flag.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/flag.ts#L8"}],"parameters":[{"id":1819,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1820,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2148,"name":"Flag","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/cli/namespace/Arg#flag"},{"id":1821,"name":"number","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/number.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/number.ts#L8"}],"signatures":[{"id":1822,"name":"number","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line option with a numeric value."}]},"sources":[{"fileName":"packages/cli/src/initializers/number.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/number.ts#L8"}],"typeParameter":[{"id":1823,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"number"},"default":{"type":"intrinsic","name":"number"}}],"parameters":[{"id":1824,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1825,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2231,"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"SingleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":1823,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"permalink":"/api/cli/namespace/Arg#number"},{"id":1826,"name":"numbers","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/numbers.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/numbers.ts#L8"}],"signatures":[{"id":1827,"name":"numbers","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line option with multiple numeric values."}]},"sources":[{"fileName":"packages/cli/src/initializers/numbers.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/numbers.ts#L8"}],"typeParameter":[{"id":1828,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"number"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"number"}}}],"parameters":[{"id":1829,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1830,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2157,"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}}],"name":"MultipleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":1828,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"permalink":"/api/cli/namespace/Arg#numbers"},{"id":1831,"name":"params","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/params.ts","line":6,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/params.ts#L6"}],"signatures":[{"id":1832,"name":"params","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring command line parameters (positional arguments)."}]},"sources":[{"fileName":"packages/cli/src/initializers/params.ts","line":6,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/params.ts#L6"}],"typeParameter":[{"id":1833,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"parameters":[{"id":1834,"name":"config","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":1833,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":1833,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}}],"permalink":"/api/cli/namespace/Arg#params"},{"id":1835,"name":"string","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/string.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/string.ts#L8"}],"signatures":[{"id":1836,"name":"string","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line option with a string value."}]},"sources":[{"fileName":"packages/cli/src/initializers/string.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/string.ts#L8"}],"typeParameter":[{"id":1837,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":1838,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1839,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2231,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SingleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":1837,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"permalink":"/api/cli/namespace/Arg#string"},{"id":1840,"name":"strings","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/initializers/strings.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/strings.ts#L8"}],"signatures":[{"id":1841,"name":"strings","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A property initializer for declaring a command line option with multiple string values."}]},"sources":[{"fileName":"packages/cli/src/initializers/strings.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/initializers/strings.ts#L8"}],"typeParameter":[{"id":1842,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"parameters":[{"id":1843,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1844,"name":"config","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2157,"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"MultipleOption","package":"@boost/args"}],"name":"PartialConfig","package":"@boost/cli"}}],"type":{"type":"reference","target":1842,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"permalink":"/api/cli/namespace/Arg#strings"}],"groups":[{"title":"Functions","children":[1793,1797,1801,1805,1809,1813,1817,1821,1826,1831,1835,1840]}],"sources":[{"fileName":"packages/cli/src/metadata/args.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/metadata/args.ts#L1"}],"permalink":"/api/cli/namespace/Arg","previousId":2231,"nextId":2134},{"id":1851,"name":"Command","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1864,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L117"}],"signatures":[{"id":1865,"name":"new Command","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L117"}],"typeParameter":[{"id":1866,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"},"default":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}},{"id":1867,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}},{"id":1868,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1869,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":1870,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1851,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true},{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true},{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Command","package":"@boost/cli"},"overwrites":{"type":"reference","target":-1,"name":"CommandManager.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"CommandManager.constructor"}},{"id":1876,"name":"exit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Method to exit the current program, with an optional error code."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":101,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L101"}],"type":{"type":"reference","target":2266,"name":"ExitHandler","package":"@boost/cli"}},{"id":1871,"name":"help","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Value of "},{"kind":"code","text":"`--help`"},{"kind":"text","text":", "},{"kind":"code","text":"`-h`"},{"kind":"text","text":" passed on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L84"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1872,"name":"locale","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Value of "},{"kind":"code","text":"`--locale`"},{"kind":"text","text":" passed on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":87,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L87"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'en\'"},{"id":1877,"name":"log","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Method to log to the console using a log level."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":104,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L104"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/log/src/types.ts","qualifiedName":"LoggerFunction"},"name":"LoggerFunction","package":"@boost/log"}},{"id":1925,"name":"onAfterRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a command has been registered."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.onAfterRegister"}},{"id":1926,"name":"onBeforeRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a command has been registered."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":18,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.onBeforeRegister"}},{"id":1943,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.options"}},{"id":1873,"name":"rest","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Additional arguments passed after "},{"kind":"code","text":"`--`"},{"kind":"text","text":" on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L90"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"defaultValue":"[]"},{"id":1874,"name":"unknown","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unknown options passed on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":93,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L93"}],"type":{"type":"reference","target":2250,"name":"UnknownOptionMap","package":"@boost/args"},"defaultValue":"{}"},{"id":1875,"name":"version","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Value of "},{"kind":"code","text":"`--version`"},{"kind":"text","text":", "},{"kind":"code","text":"`-v`"},{"kind":"text","text":" passed on the command line."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":96,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L96"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1852,"name":"aliases","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":57,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L57"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"defaultValue":"[]"},{"id":1853,"name":"allowUnknownOptions","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":59,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L59"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1854,"name":"allowVariadicParams","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":61,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L61"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]},"defaultValue":"false"},{"id":1855,"name":"categories","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":63,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L63"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"},"defaultValue":"{}"},{"id":1856,"name":"category","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":65,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L65"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":1858,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":69,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L69"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1857,"name":"description","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":67,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L67"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":1859,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":71,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L71"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":1860,"name":"options","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":73,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L73"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"},"defaultValue":"globalOptions"},{"id":1861,"name":"params","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":75,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L75"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"},"defaultValue":"[]"},{"id":1862,"name":"path","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":77,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L77"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":1863,"name":"usage","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":79,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L79"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"defaultValue":"\'\'"},{"id":1878,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L127"}],"signatures":[{"id":1879,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Validate options passed to the constructor."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L127"}],"parameters":[{"id":1880,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"overwrites":{"type":"reference","target":-1,"name":"CommandManager.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"CommandManager.blueprint"}},{"id":1944,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1945,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1946,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1947,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1948,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1949,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.configure"}},{"id":1881,"name":"createHelp","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":134,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L134"}],"signatures":[{"id":1882,"name":"createHelp","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create a React element based on the Help component."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":134,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L134"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}],"name":"Promise","package":"typescript"},"implementationOf":{"type":"reference","target":2345,"name":"Commandable.createHelp"}}],"implementationOf":{"type":"reference","target":2345,"name":"Commandable.createHelp"}},{"id":1883,"name":"executeCommand","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":154,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L154"}],"signatures":[{"id":1884,"name":"executeCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute a system native command with the given arguments\\nand pass the results through a promise. This does *not* execute Boost CLI\\ncommands, use "},{"kind":"code","text":"`runProgram()`"},{"kind":"text","text":" instead."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":154,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L154"}],"parameters":[{"id":1885,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1886,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":1887,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"Options"},"name":"Options","package":"execa"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"ExecaReturnValue"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"ExecaReturnValue","package":"execa"}],"name":"Promise","package":"typescript"}}]},{"id":1888,"name":"getArguments","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L167"}],"signatures":[{"id":1889,"name":"getArguments","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the current command class as an arguments object.\\nOptions and params must be parsed first to operate correctly."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L167"}],"type":{"type":"reference","target":2135,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true},{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true}],"name":"Arguments","package":"@boost/args"}}]},{"id":1929,"name":"getCommand","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L27"}],"signatures":[{"id":1930,"name":"getCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a command by registered path, or "},{"kind":"code","text":"`null`"},{"kind":"text","text":" if not found."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L27"}],"typeParameter":[{"id":1931,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1932,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}},{"id":1933,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":1934,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":2344,"typeArguments":[{"type":"reference","target":1931,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":1933,"name":"P","package":"@boost/cli","refersToTypeParameter":true}],"name":"Commandable","package":"@boost/cli"}]},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommand"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommand"}},{"id":1935,"name":"getCommandPaths","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L42"}],"signatures":[{"id":1936,"name":"getCommandPaths","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all registered command paths (including aliases)."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L42"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommandPaths"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommandPaths"}},{"id":1890,"name":"getMetadata","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":181,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L181"}],"signatures":[{"id":1891,"name":"getMetadata","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Validate and return all metadata registered to this command instance."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":181,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L181"}],"type":{"type":"reference","target":2328,"name":"CommandMetadata","package":"@boost/cli"},"implementationOf":{"type":"reference","target":2348,"name":"Commandable.getMetadata"}}],"implementationOf":{"type":"reference","target":2348,"name":"Commandable.getMetadata"}},{"id":1892,"name":"getParserOptions","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":218,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L218"}],"signatures":[{"id":1893,"name":"getParserOptions","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return metadata as options for argument parsing."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":218,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L218"}],"type":{"type":"reference","target":2220,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true},{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true}],"name":"ParserOptions","package":"@boost/args"},"implementationOf":{"type":"reference","target":2351,"name":"Commandable.getParserOptions"}}],"implementationOf":{"type":"reference","target":2351,"name":"Commandable.getParserOptions"}},{"id":1894,"name":"getPath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":234,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L234"}],"signatures":[{"id":1895,"name":"getPath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the command path (canonical name on the command line)."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":234,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L234"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2354,"name":"Commandable.getPath"}}],"implementationOf":{"type":"reference","target":2354,"name":"Commandable.getPath"}},{"id":1937,"name":"register","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L50"}],"signatures":[{"id":1938,"name":"register","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a command and its canonical path (must be unique),\\notherwise an error is thrown."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L50"}],"parameters":[{"id":1939,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.register"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.register"}},{"id":1896,"name":"render","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":241,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L241"}],"signatures":[{"id":1897,"name":"render","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Render a React element with Ink and output to the configured streams."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":241,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L241"}],"parameters":[{"id":1898,"name":"element","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"},"implementationOf":{"type":"reference","target":2357,"name":"Commandable.render"}}],"implementationOf":{"type":"reference","target":2357,"name":"Commandable.render"}},{"id":1919,"name":"run","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/cli/src/Command.ts","line":336,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L336"}],"signatures":[{"id":1920,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Executed when the command is being ran."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":336,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L336"}],"parameters":[{"id":1921,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true}}],"type":{"type":"union","types":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"}],"name":"Promise","package":"typescript"}]},"implementationOf":{"type":"reference","target":2361,"name":"Commandable.run"}}],"implementationOf":{"type":"reference","target":2361,"name":"Commandable.run"}},{"id":1899,"name":"runProgram","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":248,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L248"}],"signatures":[{"id":1900,"name":"runProgram","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the program within itself, by passing a custom command and argv list."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":248,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L248"}],"parameters":[{"id":1901,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","package":"typescript"}}]},{"id":1902,"name":"runTask","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":254,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L254"}],"signatures":[{"id":1903,"name":"runTask","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run a task (function) with the defined arguments and\\nthe current command instance bound to the task\'s context."}]},"sources":[{"fileName":"packages/cli/src/Command.ts","line":254,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L254"}],"typeParameter":[{"id":1904,"name":"A","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":1905,"name":"R","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1906,"name":"task","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":1907,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":255,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L255"}],"signatures":[{"id":1908,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":255,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L255"}],"parameters":[{"id":1909,"name":"this","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2367,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true}],"name":"TaskContext","package":"@boost/cli"}},{"id":1910,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":1904,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":1905,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}}},{"id":1911,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":1904,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":1905,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}],"groups":[{"title":"Constructors","children":[1864]},{"title":"Properties","children":[1876,1871,1872,1877,1925,1926,1943,1873,1874,1875,1852,1853,1854,1855,1856,1858,1857,1859,1860,1861,1862,1863]},{"title":"Methods","children":[1878,1944,1881,1883,1888,1929,1935,1890,1892,1894,1937,1896,1919,1899,1902]}],"categories":[{"title":"Events","children":[1925,1926]},{"title":"__CATEGORY__","children":[1864,1876,1871,1872,1877,1943,1873,1874,1875,1852,1853,1854,1855,1856,1858,1857,1859,1860,1861,1862,1863,1878,1944,1881,1883,1888,1929,1935,1890,1892,1894,1937,1896,1919,1899,1902]}],"sources":[{"fileName":"packages/cli/src/Command.ts","line":49,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L49"}],"typeParameters":[{"id":1950,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"},"default":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}},{"id":1951,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}},{"id":1952,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1953,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/Command.ts","line":52,"character":27,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Command.ts#L52"}]}}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/CommandManager.ts","qualifiedName":"CommandManager"},"typeArguments":[{"type":"reference","target":1868,"name":"Options","package":"@boost/cli","qualifiedName":"Command.Options","refersToTypeParameter":true}],"name":"CommandManager","package":"@boost/cli"}],"implementedTypes":[{"type":"reference","target":2344,"typeArguments":[{"type":"reference","target":1866,"name":"O","package":"@boost/cli","qualifiedName":"Command.O","refersToTypeParameter":true},{"type":"reference","target":1867,"name":"P","package":"@boost/cli","qualifiedName":"Command.P","refersToTypeParameter":true}],"name":"Commandable","package":"@boost/cli"}],"permalink":"/api/cli/class/Command","nextId":2033},{"id":2033,"name":"Program","variant":"declaration","kind":128,"flags":{},"children":[{"id":2034,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":129,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L129"}],"signatures":[{"id":2035,"name":"new Program","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":129,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L129"}],"parameters":[{"id":2036,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}},{"id":2037,"name":"streams","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2279,"name":"ProgramStreams","package":"@boost/cli"}}],"type":{"type":"reference","target":2033,"name":"Program","package":"@boost/cli"},"overwrites":{"type":"reference","target":-1,"name":"CommandManager.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"CommandManager.constructor"}},{"id":2109,"name":"onAfterRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a command has been registered."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.onAfterRegister"}},{"id":2038,"name":"onAfterRender","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a component has rendered."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":58,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L58"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2039,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the program and command have been ran."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":64,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L64"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"optional","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2110,"name":"onBeforeRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a command has been registered."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":18,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.onBeforeRegister"}},{"id":2040,"name":"onBeforeRender","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a command has run but before a component will render."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":70,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L70"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2041,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the program and command will run."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":76,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L76"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2042,"name":"onCommandFound","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when a command has been found after parsing argv."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":82,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L82"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"},{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2043,"name":"onCommandNotFound","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when a command wasn\'t found after parsing argv."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":88,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L88"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"},{"type":"intrinsic","name":"string"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2044,"name":"onExit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when the exit() handler is executed but before the process exits."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":94,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L94"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2045,"name":"onHelp","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when the help menu is rendered."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":100,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L100"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"optional","elementType":{"type":"intrinsic","name":"string"}}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":2127,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.options"}},{"id":2046,"name":"streams","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/cli/src/Program.ts","line":102,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L102"}],"type":{"type":"reference","target":2279,"name":"ProgramStreams","package":"@boost/cli"},"defaultValue":"..."},{"id":2055,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":159,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L159"}],"signatures":[{"id":2056,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":159,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L159"}],"parameters":[{"id":2057,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":-1,"name":"CommandManager.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"CommandManager.blueprint"}},{"id":2058,"name":"categories","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":177,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L177"}],"signatures":[{"id":2059,"name":"categories","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define option and command categories to supply to the running command,\\nor the program itself."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":177,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L177"}],"parameters":[{"id":2060,"name":"categories","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2128,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":2129,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":2130,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":2131,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":2132,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":2133,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.configure"}},{"id":2061,"name":"default","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":187,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L187"}],"signatures":[{"id":2062,"name":"default","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a command and its canonical path as the default command.\\nA default command should be used when stand-alone binary is required."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":187,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L187"}],"parameters":[{"id":2063,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2064,"name":"exit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":202,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L202"}],"signatures":[{"id":2065,"name":"exit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Exit the program with an error code.\\nShould be called within a command or component."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":202,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L202"}],"parameters":[{"id":2066,"name":"error","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]}},{"id":2067,"name":"errorCode","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"never"}}]},{"id":2113,"name":"getCommand","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L27"}],"signatures":[{"id":2114,"name":"getCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a command by registered path, or "},{"kind":"code","text":"`null`"},{"kind":"text","text":" if not found."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L27"}],"typeParameter":[{"id":2115,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":2116,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}},{"id":2117,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":2118,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":2344,"typeArguments":[{"type":"reference","target":1931,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":1933,"name":"P","package":"@boost/cli","refersToTypeParameter":true}],"name":"Commandable","package":"@boost/cli"}]},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommand"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommand"}},{"id":2119,"name":"getCommandPaths","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L42"}],"signatures":[{"id":2120,"name":"getCommandPaths","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all registered command paths (including aliases)."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L42"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommandPaths"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.getCommandPaths"}},{"id":2068,"name":"middleware","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":226,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L226"}],"signatures":[{"id":2069,"name":"middleware","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define a middleware function to apply to the argv list or args object."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":226,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L226"}],"parameters":[{"id":2070,"name":"middleware","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2394,"name":"Middleware","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2071,"name":"parse","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":239,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L239"}],"signatures":[{"id":2072,"name":"parse","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Parse the arguments list according to the number of commands that have been registered."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":239,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L239"}],"typeParameter":[{"id":2073,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}},{"id":2074,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"parameters":[{"id":2075,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}}],"type":{"type":"reference","target":2135,"typeArguments":[{"type":"reference","target":2073,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":2074,"name":"P","package":"@boost/cli","refersToTypeParameter":true}],"name":"Arguments","package":"@boost/args"}}]},{"id":2121,"name":"register","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L50"}],"signatures":[{"id":2122,"name":"register","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a command and its canonical path (must be unique),\\notherwise an error is thrown."}]},"sources":[{"fileName":"packages/cli/src/CommandManager.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CommandManager.ts#L50"}],"parameters":[{"id":2123,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.register"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"CommandManager.register"}},{"id":2076,"name":"renderElement","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":271,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L271"}],"signatures":[{"id":2077,"name":"renderElement","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Render a React element with Ink and output to the configured streams."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":271,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L271"}],"parameters":[{"id":2078,"name":"element","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]},{"id":2079,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":336,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L336"}],"signatures":[{"id":2080,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the program in the following steps:\\n- Apply middleware to argv list.\\n- Parse argv into an args object (of options, params, etc).\\n- Determine command to run, or fail.\\n- Run command and render output.\\n- Return exit code."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":336,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L336"}],"parameters":[{"id":2081,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}},{"id":2082,"name":"bootstrap","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2287,"name":"ProgramBootstrap","package":"@boost/cli"}},{"id":2083,"name":"rethrow","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","package":"typescript"}}]},{"id":2084,"name":"runAndExit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/Program.ts","line":368,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L368"}],"signatures":[{"id":2085,"name":"runAndExit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the program and also set the process exit code."}]},"sources":[{"fileName":"packages/cli/src/Program.ts","line":368,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L368"}],"parameters":[{"id":2086,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}},{"id":2087,"name":"bootstrap","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2287,"name":"ProgramBootstrap","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"number"}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[2034]},{"title":"Properties","children":[2109,2038,2039,2110,2040,2041,2042,2043,2044,2045,2127,2046]},{"title":"Methods","children":[2055,2058,2128,2061,2064,2113,2119,2068,2071,2121,2076,2079,2084]}],"categories":[{"title":"Events","children":[2109,2038,2039,2110,2040,2041,2042,2043,2044,2045]},{"title":"__CATEGORY__","children":[2034,2127,2046,2055,2058,2128,2061,2064,2113,2119,2068,2071,2121,2076,2079,2084]}],"sources":[{"fileName":"packages/cli/src/Program.ts","line":53,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/Program.ts#L53"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/CommandManager.ts","qualifiedName":"CommandManager"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"CommandManager","package":"@boost/cli"}],"permalink":"/api/cli/class/Program","previousId":1851,"nextId":1787},{"id":2135,"name":"Arguments","variant":"declaration","kind":256,"flags":{},"children":[{"id":2136,"name":"command","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current running command and sub-commads. Is an array split on \\":\\"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":41,"character":4}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2137,"name":"errors","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of errors detected during argument parsing."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":43,"character":4}],"type":{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}},{"id":2138,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of options to their values passed on the command line (or their default)."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":45,"character":4}],"type":{"type":"reference","target":2142,"name":"O","package":"@boost/args","qualifiedName":"Arguments.O","refersToTypeParameter":true}},{"id":2139,"name":"params","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of parameter values passed on the command line."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":47,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamType"},"typeArguments":[{"type":"reference","target":2143,"name":"P","package":"@boost/args","qualifiedName":"Arguments.P","refersToTypeParameter":true}],"name":"MapParamType","package":"@boost/args"}},{"id":2140,"name":"rest","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of arguments that appear after \\"--\\" on the command line."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":49,"character":4}],"type":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}},{"id":2141,"name":"unknown","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of unconfigured options to string values."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":51,"character":4}],"type":{"type":"reference","target":2250,"name":"UnknownOptionMap","package":"@boost/args"}}],"groups":[{"title":"Properties","children":[2136,2137,2138,2139,2140,2141]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":39,"character":17}],"typeParameters":[{"id":2142,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":2143,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"permalink":"/api/cli/interface/Arguments","previousId":2022,"nextId":2145},{"id":2145,"name":"Category","variant":"declaration","kind":256,"flags":{},"children":[{"id":2146,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":133,"character":4}],"type":{"type":"intrinsic","name":"string"}},{"id":2147,"name":"weight","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":134,"character":4}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[2146,2147]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":132,"character":17}],"permalink":"/api/cli/interface/Category","previousId":2135,"nextId":2292},{"id":2292,"name":"CommandConfig","variant":"declaration","kind":256,"flags":{},"children":[{"id":2293,"name":"aliases","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A list of aliased paths. Will not show up in the help menu, but will match on the command line."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":115,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L115"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2294,"name":"allowUnknownOptions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L117"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2295,"name":"allowVariadicParams","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L119"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]}},{"id":2296,"name":"categories","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A mapping of sub-command and option categories for this command only. Global options are automatically defined under the "},{"kind":"code","text":"`global`"},{"kind":"text","text":" category."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L121"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"}},{"id":2300,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":79,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.category"}},{"id":2302,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.deprecated"}},{"id":2303,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.description"}},{"id":2304,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.hidden"}},{"id":2297,"name":"options","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A mapping of options to their configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L123"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"}},{"id":2298,"name":"params","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A list of param (positional args) configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L125"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"}},{"id":2299,"name":"path","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique name in which to match the command on the command line amongst a list of arguments (argv)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L127"}],"type":{"type":"intrinsic","name":"string"}},{"id":2301,"name":"usage","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Define one or many usage examples to display in the help menu."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":81,"character":4}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"inheritedFrom":{"type":"reference","target":-1,"name":"BaseCommandConfig.usage"}}],"groups":[{"title":"Properties","children":[2293,2294,2295,2296,2300,2302,2303,2304,2297,2298,2299,2301]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":113,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L113"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"Command"},"name":"Command","package":"@boost/args"}],"permalink":"/api/cli/interface/CommandConfig","previousId":2145,"nextId":2328},{"id":2328,"name":"CommandMetadata","variant":"declaration","kind":256,"flags":{},"children":[{"id":2331,"name":"aliases","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A list of aliased paths. Will not show up in the help menu, but will match on the command line."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":115,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L115"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"inheritedFrom":{"type":"reference","target":2316,"name":"CommandStaticConfig.aliases"}},{"id":2332,"name":"allowUnknownOptions","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L117"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2317,"name":"CommandStaticConfig.allowUnknownOptions"}},{"id":2333,"name":"allowVariadicParams","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L119"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]},"inheritedFrom":{"type":"reference","target":2318,"name":"CommandStaticConfig.allowVariadicParams"}},{"id":2334,"name":"categories","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A mapping of sub-command and option categories for this command only. Global options are automatically defined under the "},{"kind":"code","text":"`global`"},{"kind":"text","text":" category."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L121"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":2319,"name":"CommandStaticConfig.categories"}},{"id":2338,"name":"category","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":79,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2323,"name":"CommandStaticConfig.category"}},{"id":2329,"name":"commands","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":144,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L144"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}],"name":"Record","package":"typescript"}},{"id":2340,"name":"deprecated","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2325,"name":"CommandStaticConfig.deprecated"}},{"id":2341,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2326,"name":"CommandStaticConfig.description"}},{"id":2330,"name":"hasRegisteredOptions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/types.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L140"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2315,"name":"CommandStaticConfig.hasRegisteredOptions"}},{"id":2342,"name":"hidden","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2327,"name":"CommandStaticConfig.hidden"}},{"id":2335,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A mapping of options to their configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L123"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2320,"name":"CommandStaticConfig.options"}},{"id":2336,"name":"params","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A list of param (positional args) configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L125"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2321,"name":"CommandStaticConfig.params"}},{"id":2337,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A unique name in which to match the command on the command line amongst a list of arguments (argv)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L127"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2322,"name":"CommandStaticConfig.path"}},{"id":2339,"name":"usage","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define one or many usage examples to display in the help menu."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":81,"character":4}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"inheritedFrom":{"type":"reference","target":2324,"name":"CommandStaticConfig.usage"}}],"groups":[{"title":"Properties","children":[2331,2332,2333,2334,2338,2329,2340,2341,2330,2342,2335,2336,2337,2339]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":143,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L143"}],"extendedTypes":[{"type":"reference","target":2314,"name":"CommandStaticConfig","package":"@boost/cli"}],"permalink":"/api/cli/interface/CommandMetadata","previousId":2292,"nextId":2314},{"id":2314,"name":"CommandStaticConfig","variant":"declaration","kind":256,"flags":{},"children":[{"id":2316,"name":"aliases","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A list of aliased paths. Will not show up in the help menu, but will match on the command line."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":115,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L115"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.aliases"}},{"id":2317,"name":"allowUnknownOptions","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L117"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.allowUnknownOptions"}},{"id":2318,"name":"allowVariadicParams","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be parsed, otherwise an error is thrown. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L119"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"boolean"}]},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.allowVariadicParams"}},{"id":2319,"name":"categories","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A mapping of sub-command and option categories for this command only. Global options are automatically defined under the "},{"kind":"code","text":"`global`"},{"kind":"text","text":" category."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L121"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.categories"}},{"id":2323,"name":"category","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The category this object belongs to. Will be used to group in the parent command or program. Defaults to no category."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":79,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.category"}},{"id":2325,"name":"deprecated","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.deprecated"}},{"id":2326,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.description"}},{"id":2315,"name":"hasRegisteredOptions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/types.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L140"}],"type":{"type":"intrinsic","name":"string"}},{"id":2327,"name":"hidden","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.hidden"}},{"id":2320,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A mapping of options to their configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L123"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.options"}},{"id":2321,"name":"params","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A list of param (positional args) configurations."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L125"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.params"}},{"id":2322,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A unique name in which to match the command on the command line amongst a list of arguments (argv)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L127"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.path"}},{"id":2324,"name":"usage","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define one or many usage examples to display in the help menu."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":81,"character":4}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"inheritedFrom":{"type":"reference","target":-1,"name":"Required.usage"}}],"groups":[{"title":"Properties","children":[2316,2317,2318,2319,2323,2325,2326,2315,2327,2320,2321,2322,2324]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":139,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L139"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2292,"name":"CommandConfig","package":"@boost/cli"}],"name":"Required","package":"typescript"}],"extendedBy":[{"type":"reference","target":2328,"name":"CommandMetadata"}],"permalink":"/api/cli/interface/CommandStaticConfig","previousId":2328,"nextId":2344},{"id":2344,"name":"Commandable","variant":"declaration","kind":256,"flags":{},"children":[{"id":2345,"name":"createHelp","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":150,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L150"}],"type":{"type":"reflection","declaration":{"id":2346,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":150,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L150"}],"signatures":[{"id":2347,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":150,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L150"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}]}],"name":"Promise","package":"typescript"}}]}}},{"id":2348,"name":"getMetadata","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":151,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L151"}],"type":{"type":"reflection","declaration":{"id":2349,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":151,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L151"}],"signatures":[{"id":2350,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":151,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L151"}],"type":{"type":"reference","target":2328,"name":"CommandMetadata","package":"@boost/cli"}}]}}},{"id":2351,"name":"getParserOptions","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":152,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L152"}],"type":{"type":"reflection","declaration":{"id":2352,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":152,"character":19,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L152"}],"signatures":[{"id":2353,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":152,"character":19,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L152"}],"type":{"type":"reference","target":2220,"typeArguments":[{"type":"reference","target":2365,"name":"O","package":"@boost/cli","qualifiedName":"Commandable.O","refersToTypeParameter":true},{"type":"reference","target":2366,"name":"P","package":"@boost/cli","qualifiedName":"Commandable.P","refersToTypeParameter":true}],"name":"ParserOptions","package":"@boost/args"}}]}}},{"id":2354,"name":"getPath","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L153"}],"type":{"type":"reflection","declaration":{"id":2355,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":153,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L153"}],"signatures":[{"id":2356,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":153,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L153"}],"type":{"type":"intrinsic","name":"string"}}]}}},{"id":2357,"name":"render","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":154,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L154"}],"type":{"type":"reflection","declaration":{"id":2358,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":154,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L154"}],"signatures":[{"id":2359,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":154,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L154"}],"parameters":[{"id":2360,"name":"element","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]}}},{"id":2361,"name":"run","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":155,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L155"}],"type":{"type":"reflection","declaration":{"id":2362,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":155,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L155"}],"signatures":[{"id":2363,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":155,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L155"}],"parameters":[{"id":2364,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":2366,"name":"P","package":"@boost/cli","qualifiedName":"Commandable.P","refersToTypeParameter":true}}],"type":{"type":"union","types":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2290,"name":"RunResult","package":"@boost/cli"}],"name":"Promise","package":"typescript"}]}}]}}}],"groups":[{"title":"Properties","children":[2345,2348,2351,2354,2357,2361]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":149,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L149"}],"typeParameters":[{"id":2365,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"intrinsic","name":"any"}},{"id":2366,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"implementedBy":[{"type":"reference","target":1851,"name":"Command"}],"permalink":"/api/cli/interface/Commandable","previousId":2314,"nextId":2148},{"id":2148,"name":"Flag","variant":"declaration","kind":256,"flags":{},"children":[{"id":2150,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":104,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.category"}},{"id":2149,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":123,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","target":-1,"name":"Omit.default"}},{"id":2153,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.deprecated"}},{"id":2154,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.description"}},{"id":2155,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.hidden"}},{"id":2151,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":106,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ShortOptionName"},"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.short"}},{"id":2152,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"literal","value":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.type"}}],"groups":[{"title":"Properties","children":[2150,2149,2153,2154,2155,2151,2152]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":122,"character":17}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2176,"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"Option","package":"@boost/args"},{"type":"union","types":[{"type":"literal","value":"format"},{"type":"literal","value":"validate"}]}],"name":"Omit","package":"typescript"}],"permalink":"/api/cli/interface/Flag","previousId":2344,"nextId":2256},{"id":2256,"name":"GlobalOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2257,"name":"help","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":59,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L59"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2258,"name":"locale","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":60,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L60"}],"type":{"type":"intrinsic","name":"string"}},{"id":2259,"name":"version","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":61,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L61"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2257,2258,2259]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":58,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L58"}],"permalink":"/api/cli/interface/GlobalOptions","previousId":2148,"nextId":2157},{"id":2157,"name":"MultipleOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":2158,"name":"arity","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error unless the list of values satisfy this required length."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":117,"character":4}],"type":{"type":"intrinsic","name":"number"}},{"id":2161,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":104,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2177,"name":"Option.category"}},{"id":2159,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":118,"character":4}],"type":{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true},"overwrites":{"type":"reference","target":2179,"name":"Option.default"}},{"id":2172,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2189,"name":"Option.deprecated"}},{"id":2173,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2190,"name":"Option.description"}},{"id":2163,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":4}],"type":{"type":"reflection","declaration":{"id":2164,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"signatures":[{"id":2165,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"parameters":[{"id":2166,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":2180,"name":"Option.format"}},{"id":2174,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2191,"name":"Option.hidden"}},{"id":2160,"name":"multiple","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Allow multiple values to be passed."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":120,"character":4}],"type":{"type":"literal","value":true}},{"id":2162,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":106,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ShortOptionName"},"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2178,"name":"Option.short"}},{"id":2167,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"InferArgType"},"typeArguments":[{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2184,"name":"Option.type"}},{"id":2168,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":4}],"type":{"type":"reflection","declaration":{"id":2169,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"signatures":[{"id":2170,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"parameters":[{"id":2171,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":2185,"name":"Option.validate"}}],"groups":[{"title":"Properties","children":[2158,2161,2159,2172,2173,2163,2174,2160,2162,2167,2168]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":115,"character":17}],"typeParameters":[{"id":2175,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2156,"name":"ListType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":2176,"typeArguments":[{"type":"reference","target":2175,"name":"T","package":"@boost/args","qualifiedName":"MultipleOption.T","refersToTypeParameter":true}],"name":"Option","package":"@boost/args"}],"permalink":"/api/cli/interface/MultipleOption","previousId":2256,"nextId":2176},{"id":2176,"name":"Option","variant":"declaration","kind":256,"flags":{},"children":[{"id":2177,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":104,"character":4}],"type":{"type":"intrinsic","name":"string"}},{"id":2179,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":94,"character":4}],"type":{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.default"}},{"id":2189,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.deprecated"}},{"id":2190,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.description"}},{"id":2180,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":4}],"type":{"type":"reflection","declaration":{"id":2181,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"signatures":[{"id":2182,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"parameters":[{"id":2183,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.format"}},{"id":2191,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.hidden"}},{"id":2178,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":106,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ShortOptionName"},"name":"ShortOptionName","package":"@boost/args"}},{"id":2184,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"InferArgType"},"typeArguments":[{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.type"}},{"id":2185,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":4}],"type":{"type":"reflection","declaration":{"id":2186,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"signatures":[{"id":2187,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"parameters":[{"id":2188,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.validate"}}],"groups":[{"title":"Properties","children":[2177,2179,2189,2190,2180,2191,2178,2184,2185]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":102,"character":17}],"typeParameters":[{"id":2192,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2251,"name":"ValueType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"Arg"},"typeArguments":[{"type":"reference","target":2192,"name":"T","package":"@boost/args","qualifiedName":"Option.T","refersToTypeParameter":true}],"name":"Arg","package":"@boost/args"}],"extendedBy":[{"type":"reference","target":2157,"name":"MultipleOption"},{"type":"reference","target":2231,"name":"SingleOption"}],"permalink":"/api/cli/interface/Option","previousId":2157,"nextId":2306},{"id":2306,"name":"OptionInitializer","variant":"declaration","kind":256,"flags":{},"children":[{"id":2313,"name":"[INTERNAL_INITIALIZER]","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":133,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L133"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2307,"name":"register","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":134,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L134"}],"type":{"type":"reflection","declaration":{"id":2308,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":134,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L134"}],"signatures":[{"id":2309,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":134,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L134"}],"parameters":[{"id":2310,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}},{"id":2311,"name":"property","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2312,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":135,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L135"}],"type":{"type":"intrinsic","name":"unknown"}}],"groups":[{"title":"Properties","children":[2313,2307,2312]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":132,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L132"}],"permalink":"/api/cli/interface/OptionInitializer","previousId":2176,"nextId":2201},{"id":2201,"name":"Param","variant":"declaration","kind":256,"flags":{},"children":[{"id":2204,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":94,"character":4}],"type":{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.default"}},{"id":2214,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.deprecated"}},{"id":2215,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.description"}},{"id":2205,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":4}],"type":{"type":"reflection","declaration":{"id":2206,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"signatures":[{"id":2207,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"parameters":[{"id":2208,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.format"}},{"id":2216,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.hidden"}},{"id":2202,"name":"label","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Informational label to display in terminal output."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":127,"character":4}],"type":{"type":"intrinsic","name":"string"}},{"id":2203,"name":"required","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the param is required or not. If required and not passed, the\\nparser will throw an error. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":130,"character":4}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2209,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"InferArgType"},"typeArguments":[{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.type"}},{"id":2210,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":4}],"type":{"type":"reflection","declaration":{"id":2211,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"signatures":[{"id":2212,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"parameters":[{"id":2213,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Arg.validate"}}],"groups":[{"title":"Properties","children":[2204,2214,2215,2205,2216,2202,2203,2209,2210]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":125,"character":17}],"typeParameters":[{"id":2217,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"Arg"},"typeArguments":[{"type":"reference","target":2217,"name":"T","package":"@boost/args","qualifiedName":"Param.T","refersToTypeParameter":true}],"name":"Arg","package":"@boost/args"}],"permalink":"/api/cli/interface/Param","previousId":2306,"nextId":2220},{"id":2220,"name":"ParserOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2221,"name":"commands","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of valid commands. Sub-commands should be denoted with \\":\\"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":63,"character":4}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"CommandChecker"},"name":"CommandChecker","package":"@boost/args"}]}},{"id":2224,"name":"loose","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Enable loose mode parsing."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":55,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParserSettings.loose"}},{"id":2222,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mapping of options to their type and configurations."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":65,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapOptionConfig"},"typeArguments":[{"type":"reference","target":2227,"name":"O","package":"@boost/args","qualifiedName":"ParserOptions.O","refersToTypeParameter":true}],"name":"MapOptionConfig","package":"@boost/args"}},{"id":2223,"name":"params","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of param configurations (in order)."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":67,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":2228,"name":"P","package":"@boost/args","qualifiedName":"ParserOptions.P","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"}},{"id":2225,"name":"unknown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow unknown options to be passed. Will be placed in a special "},{"kind":"code","text":"`unknown`"},{"kind":"text","text":" object."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":57,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParserSettings.unknown"}},{"id":2226,"name":"variadic","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Allow variadic params to be passed. Will be accumlated after configured params."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":59,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParserSettings.variadic"}}],"groups":[{"title":"Properties","children":[2221,2224,2222,2223,2225,2226]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":61,"character":17}],"typeParameters":[{"id":2227,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":2228,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},"default":{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ParserSettings"},"name":"ParserSettings","package":"@boost/args"}],"permalink":"/api/cli/interface/ParserOptions","previousId":2201,"nextId":2283},{"id":2283,"name":"ProgramContextType","variant":"declaration","kind":256,"flags":{},"children":[{"id":2284,"name":"exit","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":100,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L100"}],"type":{"type":"reference","target":2266,"name":"ExitHandler","package":"@boost/cli"}},{"id":2285,"name":"log","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":101,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L101"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/log/src/types.ts","qualifiedName":"LoggerFunction"},"name":"LoggerFunction","package":"@boost/log"}},{"id":2286,"name":"program","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":102,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L102"}],"type":{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}}],"groups":[{"title":"Properties","children":[2284,2285,2286]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":99,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L99"}],"permalink":"/api/cli/interface/ProgramContextType","previousId":2220,"nextId":2271},{"id":2271,"name":"ProgramOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2272,"name":"banner","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A large banner to appear at the top of the index help interface."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L78"}],"type":{"type":"intrinsic","name":"string"}},{"id":2273,"name":"bin","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The name of the binary consumers enter on the command line. Must be in kebab-case."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":80,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L80"}],"type":{"type":"intrinsic","name":"string"}},{"id":2274,"name":"delimiter","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The character(s) displayed before command line usage examples."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":82,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L82"}],"type":{"type":"intrinsic","name":"string"}},{"id":2275,"name":"footer","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A string of text to display at the bottom of the index help interface."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L84"}],"type":{"type":"intrinsic","name":"string"}},{"id":2276,"name":"header","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A string of text to display at the top of the index help interface, below the banner (if present)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":86,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L86"}],"type":{"type":"intrinsic","name":"string"}},{"id":2277,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A human readable name for your program."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":88,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L88"}],"type":{"type":"intrinsic","name":"string"}},{"id":2278,"name":"version","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current version of your CLI program. Typically the version found in your "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":". This is output when "},{"kind":"code","text":"`--version`"},{"kind":"text","text":" is passed."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L90"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2272,2273,2274,2275,2276,2277,2278]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":76,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L76"}],"extendedBy":[{"type":"reference","target":2465,"name":"IndexHelpProps"}],"permalink":"/api/cli/interface/ProgramOptions","previousId":2283,"nextId":2279},{"id":2279,"name":"ProgramStreams","variant":"declaration","kind":256,"flags":{},"children":[{"id":2280,"name":"stderr","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":94,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L94"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/process.d.ts","qualifiedName":"__global.NodeJS.WriteStream"},"name":"WriteStream","package":"@types/node","qualifiedName":"__global.NodeJS.WriteStream"}},{"id":2281,"name":"stdin","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L95"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/process.d.ts","qualifiedName":"__global.NodeJS.ReadStream"},"name":"ReadStream","package":"@types/node","qualifiedName":"__global.NodeJS.ReadStream"}},{"id":2282,"name":"stdout","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":96,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L96"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/process.d.ts","qualifiedName":"__global.NodeJS.WriteStream"},"name":"WriteStream","package":"@types/node","qualifiedName":"__global.NodeJS.WriteStream"}}],"groups":[{"title":"Properties","children":[2280,2281,2282]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":93,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L93"}],"permalink":"/api/cli/interface/ProgramStreams","previousId":2271,"nextId":2231},{"id":2231,"name":"SingleOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":2235,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A unique key to group options within categories. Couples with the "},{"kind":"code","text":"`Category`"},{"kind":"text","text":" type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":104,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2177,"name":"Option.category"}},{"id":2232,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whitelist of acceptable values."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":110,"character":4}],"type":{"type":"array","elementType":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}},{"id":2233,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"When found in an option group, increment the value for each occurrence. _(Numbers only)_"}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":112,"character":4}],"type":{"type":"conditional","checkType":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"number"},"trueType":{"type":"literal","value":true},"falseType":{"type":"intrinsic","name":"never"}}},{"id":2234,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The default value if option not provided on the command line. The value\'s type\\nis dependent on the "},{"kind":"code","text":"`type`"},{"kind":"text","text":" and "},{"kind":"code","text":"`multiple`"},{"kind":"text","text":" settings. Furthermore, this value defaults\\nto the following if not defined.\\n\\n- A zero ("},{"kind":"code","text":"`0`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`number`"},{"kind":"text","text":".\\n- An empty string ("},{"kind":"code","text":"`\'\'`"},{"kind":"text","text":") when type is "},{"kind":"code","text":"`string`"},{"kind":"text","text":".\\n- And "},{"kind":"code","text":"`false`"},{"kind":"text","text":" when type is "},{"kind":"code","text":"`boolean`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":113,"character":4}],"type":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true},"overwrites":{"type":"reference","target":2179,"name":"Option.default"}},{"id":2246,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object is deprecated or not. Will display a tag in the help menu. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":71,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2189,"name":"Option.deprecated"}},{"id":2247,"name":"description","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A description of what the object is and does. Supports basic markdown for bold, italics, and underline."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":73,"character":4}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2190,"name":"Option.description"}},{"id":2237,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":4}],"type":{"type":"reflection","declaration":{"id":2238,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"signatures":[{"id":2239,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to format the value after parsing. Must return the same type."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":96,"character":13}],"parameters":[{"id":2240,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}]}},"inheritedFrom":{"type":"reference","target":2180,"name":"Option.format"}},{"id":2248,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Whether the object should be hidden from the help menu or not. Will still match on the command line. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":75,"character":4}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2191,"name":"Option.hidden"}},{"id":2236,"name":"short","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character used as a the short option alias."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":106,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"ShortOptionName"},"name":"ShortOptionName","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2178,"name":"Option.short"}},{"id":2241,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Expected type of the provided value. When a value is captured from the command line, it will be type casted."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":98,"character":4}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"InferArgType"},"typeArguments":[{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}],"name":"InferArgType","package":"@boost/args"},"inheritedFrom":{"type":"reference","target":2184,"name":"Option.type"}},{"id":2242,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":4}],"type":{"type":"reflection","declaration":{"id":2243,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"signatures":[{"id":2244,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"An optional function to validate the provided value."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":100,"character":15}],"parameters":[{"id":2245,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":2185,"name":"Option.validate"}}],"groups":[{"title":"Properties","children":[2235,2232,2233,2234,2246,2247,2237,2248,2236,2241,2242]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":108,"character":17}],"typeParameters":[{"id":2249,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2230,"name":"ScalarType","package":"@boost/args"}}],"extendedTypes":[{"type":"reference","target":2176,"typeArguments":[{"type":"reference","target":2249,"name":"T","package":"@boost/args","qualifiedName":"SingleOption.T","refersToTypeParameter":true}],"name":"Option","package":"@boost/args"}],"permalink":"/api/cli/interface/SingleOption","previousId":2279,"nextId":1792},{"id":2134,"name":"ArgList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":2,"character":12}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"permalink":"/api/cli#ArgList","previousId":1792,"nextId":2144},{"id":2144,"name":"Argv","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":1,"character":12}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"permalink":"/api/cli#Argv","previousId":2134,"nextId":1845},{"id":1845,"name":"CLIErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/CLIError.ts","line":24,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CLIError.ts#L24"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/CLIError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/cli","preferValues":true}}},"permalink":"/api/cli#CLIErrorCode","previousId":2144,"nextId":2264},{"id":2264,"name":"Categories","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":68,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L68"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"union","types":[{"type":"reference","target":2145,"name":"Category","package":"@boost/args"},{"type":"intrinsic","name":"string"}]}],"name":"Record","package":"typescript"},"permalink":"/api/cli#Categories","previousId":1845,"nextId":2011},{"id":2011,"name":"CategoryItemMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L3"}],"typeParameters":[{"id":2015,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reflection","declaration":{"id":2012,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2013,"name":"items","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":6,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L6"}],"type":{"type":"array","elementType":{"type":"reference","target":2015,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}},{"id":2014,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":7,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L7"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2013,2014]}],"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":5,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L5"}]}}],"name":"Record","package":"typescript"},"permalink":"/api/cli#CategoryItemMap","previousId":2264,"nextId":2305},{"id":2305,"name":"CommandConfigMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":130,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L130"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2292,"name":"CommandConfig","package":"@boost/cli"}],"name":"Record","package":"typescript"},"permalink":"/api/cli#CommandConfigMap","previousId":2011,"nextId":2343},{"id":2343,"name":"CommandMetadataMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":147,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L147"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2328,"name":"CommandMetadata","package":"@boost/cli"}],"name":"Record","package":"typescript"},"permalink":"/api/cli#CommandMetadataMap","previousId":2305,"nextId":2291},{"id":2291,"name":"CommandPath","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":111,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L111"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/cli#CommandPath","previousId":2343,"nextId":2265},{"id":2265,"name":"ExitCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":72,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L72"}],"type":{"type":"intrinsic","name":"number"},"permalink":"/api/cli#ExitCode","previousId":2291,"nextId":2266},{"id":2266,"name":"ExitHandler","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":74,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L74"}],"type":{"type":"reflection","declaration":{"id":2267,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":74,"character":26,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L74"}],"signatures":[{"id":2268,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2269,"name":"error","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"intrinsic","name":"string"}]}},{"id":2270,"name":"code","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"void"}}]}},"permalink":"/api/cli#ExitHandler","previousId":2265,"nextId":2156},{"id":2156,"name":"ListType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":3,"character":12}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"number"}},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},"permalink":"/api/cli#ListType","previousId":2266,"nextId":2394},{"id":2394,"name":"Middleware","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":176,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L176"}],"type":{"type":"reflection","declaration":{"id":2395,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":176,"character":25,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L176"}],"signatures":[{"id":2396,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2397,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}},{"id":2398,"name":"parse","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2390,"name":"MiddlewareCallback","package":"@boost/cli"}},{"id":2399,"name":"logger","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/log/src/types.ts","qualifiedName":"Loggable"},"name":"Loggable","package":"@boost/log"}}],"type":{"type":"union","types":[{"type":"reference","target":2389,"name":"MiddlewareArguments","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2389,"name":"MiddlewareArguments","package":"@boost/cli"}],"name":"Promise","package":"typescript"}]}}]}},"permalink":"/api/cli#Middleware","previousId":2156,"nextId":2389},{"id":2389,"name":"MiddlewareArguments","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":172,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L172"}],"type":{"type":"reference","target":2135,"typeArguments":[{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"},{"type":"reference","target":2134,"name":"ArgList","package":"@boost/args"}],"name":"Arguments","package":"@boost/args"},"permalink":"/api/cli#MiddlewareArguments","previousId":2394,"nextId":2390},{"id":2390,"name":"MiddlewareCallback","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":174,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L174"}],"type":{"type":"reflection","declaration":{"id":2391,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":174,"character":33,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L174"}],"signatures":[{"id":2392,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2393,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}}],"type":{"type":"union","types":[{"type":"reference","target":2389,"name":"MiddlewareArguments","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2389,"name":"MiddlewareArguments","package":"@boost/cli"}],"name":"Promise","package":"typescript"}]}}]}},"permalink":"/api/cli#MiddlewareCallback","previousId":2389,"nextId":2193},{"id":2193,"name":"OptionConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Abstract type for easier typing."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":137,"character":12}],"type":{"type":"intersection","types":[{"type":"reference","target":2176,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Option","package":"@boost/args"},{"type":"reflection","declaration":{"id":2194,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2195,"name":"arity","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":138,"character":4}],"type":{"type":"intrinsic","name":"number"}},{"id":2196,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":139,"character":4}],"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}},{"id":2197,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":140,"character":4}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2198,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":141,"character":4}],"type":{"type":"reference","target":2251,"name":"ValueType","package":"@boost/args"}},{"id":2199,"name":"multiple","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":142,"character":4}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2195,2196,2197,2198,2199]}],"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":137,"character":41}]}}]},"permalink":"/api/cli#OptionConfig","previousId":2390,"nextId":2200},{"id":2200,"name":"OptionConfigMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":144,"character":12}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2193,"name":"OptionConfig","package":"@boost/args"}],"name":"Record","package":"typescript"},"permalink":"/api/cli#OptionConfigMap","previousId":2193,"nextId":2260},{"id":2260,"name":"Options","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":64,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L64"}],"typeParameters":[{"id":2261,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapOptionConfig"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2261,"name":"T","package":"@boost/cli","refersToTypeParameter":true},{"type":"typeOperator","operator":"keyof","target":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}}],"name":"Omit","package":"typescript"}],"name":"MapOptionConfig","package":"@boost/args"},"permalink":"/api/cli#Options","previousId":2200,"nextId":2218},{"id":2218,"name":"ParamConfig","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Abstract type for easier typing."}]},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":146,"character":12}],"type":{"type":"reference","target":2201,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Param","package":"@boost/args"},"permalink":"/api/cli#ParamConfig","previousId":2260,"nextId":2219},{"id":2219,"name":"ParamConfigList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":147,"character":12}],"type":{"type":"array","elementType":{"type":"reference","target":2218,"name":"ParamConfig","package":"@boost/args"}},"permalink":"/api/cli#ParamConfigList","previousId":2218,"nextId":2262},{"id":2262,"name":"Params","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":66,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L66"}],"typeParameters":[{"id":2263,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}}],"type":{"type":"reference","target":{"sourceFileName":"../packages/args/src/types.ts","qualifiedName":"MapParamConfig"},"typeArguments":[{"type":"reference","target":2263,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MapParamConfig","package":"@boost/args"},"permalink":"/api/cli#Params","previousId":2219,"nextId":2252},{"id":2252,"name":"PartialConfig","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":54,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L54"}],"typeParameters":[{"id":2253,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2253,"name":"T","package":"@boost/cli","refersToTypeParameter":true},{"type":"union","types":[{"type":"literal","value":"description"},{"type":"literal","value":"multiple"},{"type":"literal","value":"path"},{"type":"literal","value":"type"}]}],"name":"Omit","package":"typescript"},"permalink":"/api/cli#PartialConfig","previousId":2262,"nextId":2229},{"id":2229,"name":"PrimitiveType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":5,"character":12}],"type":{"type":"union","types":[{"type":"reference","target":2230,"name":"ScalarType","package":"@boost/args"},{"type":"intrinsic","name":"boolean"}]},"permalink":"/api/cli#PrimitiveType","previousId":2252,"nextId":2287},{"id":2287,"name":"ProgramBootstrap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":105,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L105"}],"type":{"type":"reflection","declaration":{"id":2288,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":105,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L105"}],"signatures":[{"id":2289,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"},{"type":"intrinsic","name":"void"}]}}]}},"permalink":"/api/cli#ProgramBootstrap","previousId":2229,"nextId":2290},{"id":2290,"name":"RunResult","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":109,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L109"}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"undefined"},{"type":"intrinsic","name":"void"}]},"permalink":"/api/cli#RunResult","previousId":2287,"nextId":2230},{"id":2230,"name":"ScalarType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":4,"character":12}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"}]},"permalink":"/api/cli#ScalarType","previousId":2290,"nextId":2400},{"id":2400,"name":"StyleType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":184,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L184"}],"type":{"type":"union","types":[{"type":"literal","value":"default"},{"type":"literal","value":"failure"},{"type":"literal","value":"info"},{"type":"literal","value":"inverted"},{"type":"literal","value":"muted"},{"type":"literal","value":"notice"},{"type":"literal","value":"success"},{"type":"literal","value":"warning"}]},"permalink":"/api/cli#StyleType","previousId":2230,"nextId":2367},{"id":2367,"name":"TaskContext","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":160,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L160"}],"typeParameters":[{"id":2388,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"},"default":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}}],"type":{"type":"intersection","types":[{"type":"reference","target":2388,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reflection","declaration":{"id":2368,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2369,"name":"exit","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":161,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L161"}],"type":{"type":"reference","target":2266,"name":"ExitHandler","package":"@boost/cli"}},{"id":2370,"name":"log","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L162"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/log/src/types.ts","qualifiedName":"LoggerFunction"},"name":"LoggerFunction","package":"@boost/log"}},{"id":2371,"name":"rest","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":163,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L163"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2373,"name":"runProgram","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":166,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L166"}],"type":{"type":"reflection","declaration":{"id":2374,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":166,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L166"}],"signatures":[{"id":2375,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2376,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"}],"name":"Promise","package":"typescript"}}]}}},{"id":2377,"name":"runTask","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L167"}],"type":{"type":"reflection","declaration":{"id":2378,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":167,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L167"}],"signatures":[{"id":2379,"name":"__type","variant":"signature","kind":4096,"flags":{},"typeParameter":[{"id":2386,"name":"A","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":2387,"name":"R","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2380,"name":"task","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":2381,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":167,"character":41,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L167"}],"signatures":[{"id":2382,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2383,"name":"this","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2367,"typeArguments":[{"type":"reference","target":2388,"name":"O","package":"@boost/cli","refersToTypeParameter":true}],"name":"TaskContext","package":"@boost/cli"}},{"id":2384,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":2386,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":2387,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}}},{"id":2385,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":2386,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":2387,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}}},{"id":2372,"name":"unknown","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L164"}],"type":{"type":"reference","target":2250,"name":"UnknownOptionMap","package":"@boost/args"}}],"groups":[{"title":"Properties","children":[2369,2370,2371,2373,2377,2372]}],"sources":[{"fileName":"packages/cli/src/types.ts","line":160,"character":71,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L160"}]}}]},"permalink":"/api/cli#TaskContext","previousId":2400,"nextId":2401},{"id":2401,"name":"ThemePalette","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":194,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L194"}],"type":{"type":"mapped","parameter":"T","parameterType":{"type":"reference","target":2400,"name":"StyleType","package":"@boost/cli"},"templateType":{"type":"intrinsic","name":"string"}},"permalink":"/api/cli#ThemePalette","previousId":2367,"nextId":2250},{"id":2250,"name":"UnknownOptionMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":8,"character":12}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript"},"permalink":"/api/cli#UnknownOptionMap","previousId":2401,"nextId":2251},{"id":2251,"name":"ValueType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/args/mjs/types.d.ts","line":6,"character":12}],"type":{"type":"union","types":[{"type":"reference","target":2156,"name":"ListType","package":"@boost/args"},{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}]},"permalink":"/api/cli#ValueType","previousId":2250,"nextId":2254},{"id":2254,"name":"Writeable","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/types.ts","line":56,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L56"}],"typeParameters":[{"id":2255,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"mapped","parameter":"P","parameterType":{"type":"typeOperator","operator":"keyof","target":{"type":"reference","target":2255,"name":"T","package":"@boost/cli","refersToTypeParameter":true}},"templateType":{"type":"indexedAccess","indexType":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/types.ts","qualifiedName":"P"},"name":"P","package":"@boost/cli","refersToTypeParameter":true},"objectType":{"type":"reference","target":2255,"name":"T","package":"@boost/cli","refersToTypeParameter":true}},"readonlyModifier":"-"},"permalink":"/api/cli#Writeable","previousId":2251,"nextId":1846},{"id":1846,"name":"CLIError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/CLIError.ts","line":26,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/CLIError.ts#L26"}],"type":{"type":"reflection","declaration":{"id":1847,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":1848,"name":"new CLIError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":1849,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"COMMAND_DEFINED"},{"type":"literal","value":"COMMAND_INVALID_REGISTER"},{"type":"literal","value":"COMMAND_INVALID_RUN"},{"type":"literal","value":"COMMAND_INVALID_SUBPATH"},{"type":"literal","value":"COMMAND_MIXED_DEFAULT"},{"type":"literal","value":"COMMAND_MIXED_NONDEFAULT"},{"type":"literal","value":"COMMAND_NO_PROGRAM"},{"type":"literal","value":"COMMAND_NONE_REGISTERED"},{"type":"literal","value":"COMMAND_UNKNOWN"},{"type":"literal","value":"MIDDLEWARE_INVALID"},{"type":"literal","value":"OPTION_RESERVED"},{"type":"literal","value":"PARAMS_RUN_ONLY"},{"type":"literal","value":"REACT_RENDER_NO_NESTED"},{"type":"literal","value":"THEME_UNKNOWN"}]}},{"id":1850,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"COMMAND_DEFINED"},{"type":"literal","value":"COMMAND_INVALID_REGISTER"},{"type":"literal","value":"COMMAND_INVALID_RUN"},{"type":"literal","value":"COMMAND_INVALID_SUBPATH"},{"type":"literal","value":"COMMAND_MIXED_DEFAULT"},{"type":"literal","value":"COMMAND_MIXED_NONDEFAULT"},{"type":"literal","value":"COMMAND_NO_PROGRAM"},{"type":"literal","value":"COMMAND_NONE_REGISTERED"},{"type":"literal","value":"COMMAND_UNKNOWN"},{"type":"literal","value":"MIDDLEWARE_INVALID"},{"type":"literal","value":"OPTION_RESERVED"},{"type":"literal","value":"PARAMS_RUN_ONLY"},{"type":"literal","value":"REACT_RENDER_NO_NESTED"},{"type":"literal","value":"THEME_UNKNOWN"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/cli#CLIError","previousId":2254,"nextId":1966},{"id":1966,"name":"DELIMITER","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L37"}],"type":{"type":"literal","value":"$ "},"defaultValue":"\'$ \'","permalink":"/api/cli#DELIMITER","previousId":1846,"nextId":1957},{"id":1957,"name":"EXIT_FAIL","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":9,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L9"}],"type":{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"},"defaultValue":"1","permalink":"/api/cli#EXIT_FAIL","previousId":1966,"nextId":1956},{"id":1956,"name":"EXIT_PASS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":8,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L8"}],"type":{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"},"defaultValue":"0","permalink":"/api/cli#EXIT_PASS","previousId":1957,"nextId":1961},{"id":1961,"name":"INTERNAL_INITIALIZER","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":14,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L14"}],"type":{"type":"query","queryType":{"type":"reference","target":1961,"name":"INTERNAL_INITIALIZER","package":"@boost/cli"}},"defaultValue":"...","permalink":"/api/cli#INTERNAL_INITIALIZER","previousId":1956,"nextId":1958},{"id":1958,"name":"INTERNAL_OPTIONS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L11"}],"type":{"type":"query","queryType":{"type":"reference","target":1958,"name":"INTERNAL_OPTIONS","package":"@boost/cli"}},"defaultValue":"...","permalink":"/api/cli#INTERNAL_OPTIONS","previousId":1961,"nextId":1959},{"id":1959,"name":"INTERNAL_PARAMS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L12"}],"type":{"type":"query","queryType":{"type":"reference","target":1959,"name":"INTERNAL_PARAMS","package":"@boost/cli"}},"defaultValue":"...","permalink":"/api/cli#INTERNAL_PARAMS","previousId":1958,"nextId":1960},{"id":1960,"name":"INTERNAL_PROGRAM","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":13,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L13"}],"type":{"type":"query","queryType":{"type":"reference","target":1960,"name":"INTERNAL_PROGRAM","package":"@boost/cli"}},"defaultValue":"...","permalink":"/api/cli#INTERNAL_PROGRAM","previousId":1959,"nextId":1955},{"id":1955,"name":"LOCALE_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L6"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/cli#LOCALE_FORMAT","previousId":1960,"nextId":1962},{"id":1962,"name":"RESERVED_OPTIONS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":16,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L16"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"defaultValue":"...","permalink":"/api/cli#RESERVED_OPTIONS","previousId":1955,"nextId":1963},{"id":1963,"name":"SPACING_COL","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":33,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L33"}],"type":{"type":"literal","value":1},"defaultValue":"1","permalink":"/api/cli#SPACING_COL","previousId":1962,"nextId":1964},{"id":1964,"name":"SPACING_COL_WIDE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":34,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L34"}],"type":{"type":"literal","value":2},"defaultValue":"2","permalink":"/api/cli#SPACING_COL_WIDE","previousId":1963,"nextId":1965},{"id":1965,"name":"SPACING_ROW","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":35,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L35"}],"type":{"type":"literal","value":1},"defaultValue":"1","permalink":"/api/cli#SPACING_ROW","previousId":1964,"nextId":1954},{"id":1954,"name":"VERSION_FORMAT","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/constants.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/constants.ts#L4"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/cli#VERSION_FORMAT","previousId":1965},{"id":1787,"name":"Config","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/decorators/Config.ts","line":16,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Config.ts#L16"}],"signatures":[{"id":1788,"name":"Config","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A class decorator for defining the following metadata on a "},{"kind":"code","text":"`Command`"},{"kind":"text","text":".\\n- path\\n- description\\n- aliases\\n- allowUnknownOptions\\n- allowVariadicParams\\n- categories\\n- category\\n- deprecated\\n- hidden\\n- usage"}]},"sources":[{"fileName":"packages/cli/src/decorators/Config.ts","line":16,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/decorators/Config.ts#L16"}],"parameters":[{"id":1789,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1790,"name":"description","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1791,"name":"config","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2252,"typeArguments":[{"type":"reference","target":2314,"name":"CommandStaticConfig","package":"@boost/cli"}],"name":"PartialConfig","package":"@boost/cli"}],"name":"Partial","package":"typescript"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"ClassDecorator"},"name":"ClassDecorator","package":"typescript"}}],"permalink":"/api/cli/function/Config","previousId":2033,"nextId":1967},{"id":1967,"name":"applyMarkdown","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/applyMarkdown.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/applyMarkdown.ts#L3"}],"signatures":[{"id":1968,"name":"applyMarkdown","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/applyMarkdown.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/applyMarkdown.ts#L3"}],"parameters":[{"id":1969,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/applyMarkdown","previousId":1787,"nextId":1970},{"id":1970,"name":"applyStyle","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/applyStyle.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/applyStyle.ts#L5"}],"signatures":[{"id":1971,"name":"applyStyle","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/applyStyle.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/applyStyle.ts#L5"}],"parameters":[{"id":1972,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1973,"name":"type","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2400,"name":"StyleType","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/applyStyle","previousId":1967,"nextId":2025},{"id":2025,"name":"checkNodeRequirement","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/middleware/checkNodeRequirement.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/middleware/checkNodeRequirement.ts#L8"}],"signatures":[{"id":2026,"name":"checkNodeRequirement","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Verify that the currently running Node.js process.version satisfies the given semver range.\\nIf not, a console error will be logged, or an error will be thrown."}]},"sources":[{"fileName":"packages/cli/src/middleware/checkNodeRequirement.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/middleware/checkNodeRequirement.ts#L8"}],"parameters":[{"id":2027,"name":"range","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2028,"name":"throws","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"reference","target":2394,"name":"Middleware","package":"@boost/cli"}}],"permalink":"/api/cli/function/checkNodeRequirement","previousId":1970,"nextId":2029},{"id":2029,"name":"checkPackageOutdated","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/middleware/checkPackageOutdated.ts","line":37,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/middleware/checkPackageOutdated.ts#L37"}],"signatures":[{"id":2030,"name":"checkPackageOutdated","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Verify that a package and its provided version is using the latest distribution\\nversion by checking against the npm registry. If not, a console message will be logged."}]},"sources":[{"fileName":"packages/cli/src/middleware/checkPackageOutdated.ts","line":37,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/middleware/checkPackageOutdated.ts#L37"}],"parameters":[{"id":2031,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2032,"name":"version","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":2394,"name":"Middleware","package":"@boost/cli"}}],"permalink":"/api/cli/function/checkPackageOutdated","previousId":2025,"nextId":1974},{"id":1974,"name":"formatCommandCall","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatCommandCall.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatCommandCall.ts#L4"}],"signatures":[{"id":1975,"name":"formatCommandCall","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatCommandCall.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatCommandCall.ts#L4"}],"parameters":[{"id":1976,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1977,"name":"metadata","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2292,"name":"CommandConfig","package":"@boost/cli"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/formatCommandCall","previousId":2029,"nextId":1978},{"id":1978,"name":"formatDescription","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L7"}],"signatures":[{"id":1979,"name":"formatDescription","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L7"}],"parameters":[{"id":1980,"name":"config","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":1981,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":1982,"name":"choices","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":9,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L9"}],"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}},{"id":1983,"name":"default","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":10,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L10"}],"type":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}},{"id":1985,"name":"deprecated","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":12,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L12"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1984,"name":"description","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":11,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L11"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[1982,1983,1985,1984]}],"sources":[{"fileName":"packages/cli/src/helpers/formatDescription.ts","line":8,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatDescription.ts#L8"}]}}},{"id":1986,"name":"tags","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}},"defaultValue":"[]"}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/formatDescription","previousId":1974,"nextId":1987},{"id":1987,"name":"formatType","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L3"}],"signatures":[{"id":1988,"name":"formatType","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L3"}],"parameters":[{"id":1989,"name":"config","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":1990,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":1991,"name":"label","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":5,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L5"}],"type":{"type":"intrinsic","name":"string"}},{"id":1992,"name":"multiple","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":6,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L6"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1993,"name":"required","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":7,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L7"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1994,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":8,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L8"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[1991,1992,1993,1994]}],"sources":[{"fileName":"packages/cli/src/helpers/formatType.ts","line":4,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatType.ts#L4"}]}}},{"id":1995,"name":"inline","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/formatType","previousId":1978,"nextId":1996},{"id":1996,"name":"formatValue","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatValue.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatValue.ts#L3"}],"signatures":[{"id":1997,"name":"formatValue","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/formatValue.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/formatValue.ts#L3"}],"parameters":[{"id":1998,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/cli/function/formatValue","previousId":1987,"nextId":1999},{"id":1999,"name":"getLongestWidth","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/getLongestWidth.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/getLongestWidth.ts#L3"}],"signatures":[{"id":2000,"name":"getLongestWidth","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/getLongestWidth.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/getLongestWidth.ts#L3"}],"parameters":[{"id":2001,"name":"values","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"intrinsic","name":"number"}}],"permalink":"/api/cli/function/getLongestWidth","previousId":1996,"nextId":2002},{"id":2002,"name":"groupByCategory","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"signatures":[{"id":2003,"name":"groupByCategory","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"typeParameter":[{"id":2004,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reflection","declaration":{"id":2005,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2006,"name":"category","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":44,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"type":{"type":"intrinsic","name":"string"}},{"id":2007,"name":"hidden","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":63,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2008,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":81,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2006,2007,2008]}],"sources":[{"fileName":"packages/cli/src/helpers/groupByCategory.ts","line":11,"character":42,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/groupByCategory.ts#L11"}]}}}],"parameters":[{"id":2009,"name":"items","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2004,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}},{"id":2010,"name":"categories","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"}}],"type":{"type":"reference","target":2011,"typeArguments":[{"type":"reference","target":2004,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"CategoryItemMap","package":"@boost/cli"}}],"permalink":"/api/cli/function/groupByCategory","previousId":1999,"nextId":2016},{"id":2016,"name":"isArgvSize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/isArgvSize.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/isArgvSize.ts#L4"}],"signatures":[{"id":2017,"name":"isArgvSize","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/isArgvSize.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/isArgvSize.ts#L4"}],"parameters":[{"id":2018,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2144,"name":"Argv","package":"@boost/args"}},{"id":2019,"name":"size","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/cli/function/isArgvSize","previousId":2002,"nextId":2020},{"id":2020,"name":"loadTheme","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/loadTheme.ts","line":10,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/loadTheme.ts#L10"}],"signatures":[{"id":2021,"name":"loadTheme","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/loadTheme.ts","line":10,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/loadTheme.ts#L10"}],"type":{"type":"reference","target":2401,"name":"ThemePalette","package":"@boost/cli"}}],"permalink":"/api/cli/function/loadTheme","previousId":2016,"nextId":2022},{"id":2022,"name":"mapCommandMetadata","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/mapCommandMetadata.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/mapCommandMetadata.ts#L3"}],"signatures":[{"id":2023,"name":"mapCommandMetadata","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/helpers/mapCommandMetadata.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/helpers/mapCommandMetadata.ts#L3"}],"parameters":[{"id":2024,"name":"commands","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2344,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"array","elementType":{"type":"intrinsic","name":"any"}}],"name":"Commandable","package":"@boost/cli"}],"name":"Record","package":"typescript"}}],"type":{"type":"reference","target":2343,"name":"CommandMetadataMap","package":"@boost/cli"}}],"permalink":"/api/cli/function/mapCommandMetadata","previousId":2020,"nextId":2135}],"groups":[{"title":"Classes","children":[1851,2033]},{"title":"Functions","children":[1787,1967,1970,2025,2029,1974,1978,1987,1996,1999,2002,2016,2020,2022]},{"title":"Interfaces","children":[2135,2145,2292,2328,2314,2344,2148,2256,2157,2176,2306,2201,2220,2283,2271,2279,2231]},{"title":"Namespaces","children":[1792]},{"title":"Type Aliases","children":[2134,2144,1845,2264,2011,2305,2343,2291,2265,2266,2156,2394,2389,2390,2193,2200,2260,2218,2219,2262,2252,2229,2287,2290,2230,2400,2367,2401,2250,2251,2254]},{"title":"Variables","children":[1846,1966,1957,1956,1961,1958,1959,1960,1955,1962,1963,1964,1965,1954]}],"sources":[{"fileName":"packages/cli/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/index.ts#L1"}],"permalink":"/api/cli"},"urlSlug":"cli"},{"index":false,"label":"Components & hooks","reflection":{"id":10,"name":"@boost/cli/react","variant":"declaration","kind":2,"flags":{},"children":[{"id":2422,"name":"Failure","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a failure state for errors and warnings."}]},"children":[{"id":2423,"name":"constructor","variant":"declaration","kind":512,"flags":{"isExternal":true},"sources":[{"fileName":"node_modules/@types/react/index.d.ts","line":984,"character":8},{"fileName":"node_modules/@types/react/index.d.ts","line":989,"character":8}],"signatures":[{"id":2424,"name":"new Failure","variant":"signature","kind":16384,"flags":{"isExternal":true},"sources":[{"fileName":"node_modules/@types/react/index.d.ts","line":984,"character":8}],"parameters":[{"id":2425,"name":"props","variant":"param","kind":32768,"flags":{"isExternal":true},"type":{"type":"union","types":[{"type":"reference","target":2415,"name":"FailureProps","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":2415,"name":"FailureProps","package":"@boost/cli"}],"name":"Readonly","package":"typescript"}]}}],"type":{"type":"reference","target":2422,"name":"Failure","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"Component.constructor"}},{"id":2426,"name":"new Failure","variant":"signature","kind":16384,"flags":{"isExternal":true},"comment":{"summary":[],"blockTags":[{"tag":"@deprecated","content":[]},{"tag":"@see","content":[{"kind":"inline-tag","tag":"@link","text":"React Docs","target":"https://legacy.reactjs.org/docs/legacy-context.html"}]}]},"sources":[{"fileName":"node_modules/@types/react/index.d.ts","line":989,"character":8}],"parameters":[{"id":2427,"name":"props","variant":"param","kind":32768,"flags":{"isExternal":true},"type":{"type":"reference","target":2415,"name":"FailureProps","package":"@boost/cli"}},{"id":2428,"name":"context","variant":"param","kind":32768,"flags":{"isExternal":true},"type":{"type":"intrinsic","name":"any"}}],"type":{"type":"reference","target":2422,"name":"Failure","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"Component.constructor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Component.constructor"}},{"id":2437,"name":"render","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":152,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L152"}],"signatures":[{"id":2438,"name":"render","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":152,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L152"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"},"overwrites":{"type":"reference","target":-1,"name":"Component.render"}}],"overwrites":{"type":"reference","target":-1,"name":"Component.render"}},{"id":2431,"name":"renderCodeFrame","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L50"}],"signatures":[{"id":2432,"name":"renderCodeFrame","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L50"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}]}}]},{"id":2433,"name":"renderStackTrace","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L105"}],"signatures":[{"id":2434,"name":"renderStackTrace","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L105"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}]}}]},{"id":2435,"name":"renderWarnings","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L127"}],"signatures":[{"id":2436,"name":"renderWarnings","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L127"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}]}}]},{"id":2429,"name":"shouldHideStackTrace","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L36"}],"signatures":[{"id":2430,"name":"shouldHideStackTrace","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L36"}],"type":{"type":"intrinsic","name":"boolean"}}]}],"groups":[{"title":"Constructors","children":[2423]},{"title":"Methods","children":[2437,2431,2433,2435,2429]}],"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":35,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L35"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.Component"},"typeArguments":[{"type":"reference","target":2415,"name":"FailureProps","package":"@boost/cli"}],"name":"Component","package":"@types/react","qualifiedName":"React.Component"}],"permalink":"/api/cli-react/class/Failure","nextId":2402},{"id":2405,"name":"ConfirmProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2406,"name":"invalidError","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Error message to display when an invalid character is pressed. Defaults to a custom message."}]},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L12"}],"type":{"type":"intrinsic","name":"string"}},{"id":2409,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label to display before or above the prompt itself."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.label"}},{"id":2407,"name":"no","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Character that triggers a falsy state when pressed. Defaults to \\"N\\"."}]},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L14"}],"type":{"type":"intrinsic","name":"string"}},{"id":2411,"name":"onSubmit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"type":{"type":"reflection","declaration":{"id":2412,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"signatures":[{"id":2413,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"parameters":[{"id":2414,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.onSubmit"}},{"id":2410,"name":"prefix","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character symbol to display before the label. Defaults to \\"?\\"\\"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L14"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Omit.prefix"}},{"id":2408,"name":"yes","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Character that triggers a truthy state when pressed. Defaults to \\"y\\"."}]},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L16"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2406,2409,2407,2411,2410,2408]}],"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":10,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L10"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/Prompt.tsx","qualifiedName":"PromptProps"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"PromptProps","package":"@boost/cli"},{"type":"literal","value":"validate"}],"name":"Omit","package":"typescript"}],"permalink":"/api/cli-react/interface/ConfirmProps","previousId":2604,"nextId":2415},{"id":2415,"name":"FailureProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2416,"name":"binName","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Name of the binary being executed."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L19"}],"type":{"type":"intrinsic","name":"string"}},{"id":2417,"name":"commandLine","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Full length command line being ran."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L21"}],"type":{"type":"intrinsic","name":"string"}},{"id":2418,"name":"delimiter","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Delimiter to prefix within examples. Defaults to \\"$ \\"."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L23"}],"type":{"type":"intrinsic","name":"string"}},{"id":2419,"name":"error","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The primary error to display in red."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L25"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}},{"id":2420,"name":"hideStackTrace","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Hide the primary error stack trace. Defaults to "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L27"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2421,"name":"warnings","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Optional errors as warnings to display in yellow."}]},"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L29"}],"type":{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}}],"groups":[{"title":"Properties","children":[2416,2417,2418,2419,2420,2421]}],"sources":[{"fileName":"packages/cli/src/components/Failure.tsx","line":17,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Failure.tsx#L17"}],"permalink":"/api/cli-react/interface/FailureProps","previousId":2405,"nextId":2442},{"id":2442,"name":"HeaderProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2443,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Text to display for the label."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L8"}],"type":{"type":"intrinsic","name":"string"}},{"id":2445,"name":"marginBottom","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The top margin. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L12"}],"type":{"type":"intrinsic","name":"number"}},{"id":2444,"name":"marginTop","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The bottom margin. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L10"}],"type":{"type":"intrinsic","name":"number"}},{"id":2446,"name":"type","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Customize the background color using Style. Defaults to normal text."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L14"}],"type":{"type":"union","types":[{"type":"reference","target":2400,"name":"StyleType","package":"@boost/cli"},{"type":"literal","value":"none"}]}}],"groups":[{"title":"Properties","children":[2443,2445,2444,2446]}],"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":6,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L6"}],"permalink":"/api/cli-react/interface/HeaderProps","previousId":2415,"nextId":2450},{"id":2450,"name":"HelpProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2451,"name":"categories","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mapping of categories to use for command and option grouping."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L32"}],"type":{"type":"reference","target":2264,"name":"Categories","package":"@boost/cli"}},{"id":2453,"name":"commands","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mapping of commands, typically sub-commands."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L36"}],"type":{"type":"reference","target":2305,"name":"CommandConfigMap","package":"@boost/cli"}},{"id":2452,"name":"config","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Configuration metadata about the current command."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L34"}],"type":{"type":"reference","target":2292,"name":"CommandConfig","package":"@boost/cli"}},{"id":2454,"name":"delimiter","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Delimiter to prefix within examples. Defaults to \\"$ \\"."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L38"}],"type":{"type":"intrinsic","name":"string"}},{"id":2455,"name":"header","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A header to display at the top of the output."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":40,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L40"}],"type":{"type":"intrinsic","name":"string"}},{"id":2456,"name":"options","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mapping of command options."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L42"}],"type":{"type":"reference","target":2200,"name":"OptionConfigMap","package":"@boost/args"}},{"id":2457,"name":"params","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of command params."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":44,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L44"}],"type":{"type":"reference","target":2219,"name":"ParamConfigList","package":"@boost/args"}}],"groups":[{"title":"Properties","children":[2451,2453,2452,2454,2455,2456,2457]}],"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":30,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L30"}],"permalink":"/api/cli-react/interface/HelpProps","previousId":2442,"nextId":2465},{"id":2465,"name":"IndexHelpProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2467,"name":"banner","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A large banner to appear at the top of the index help interface."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L78"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2272,"name":"ProgramOptions.banner"}},{"id":2468,"name":"bin","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The name of the binary consumers enter on the command line. Must be in kebab-case."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":80,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L80"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2273,"name":"ProgramOptions.bin"}},{"id":2466,"name":"children","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/components/IndexHelp.tsx","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/IndexHelp.tsx#L8"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}},{"id":2469,"name":"delimiter","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The character(s) displayed before command line usage examples."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":82,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L82"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2274,"name":"ProgramOptions.delimiter"}},{"id":2470,"name":"footer","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A string of text to display at the bottom of the index help interface."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L84"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2275,"name":"ProgramOptions.footer"}},{"id":2471,"name":"header","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A string of text to display at the top of the index help interface, below the banner (if present)."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":86,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L86"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2276,"name":"ProgramOptions.header"}},{"id":2472,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"A human readable name for your program."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":88,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L88"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2277,"name":"ProgramOptions.name"}},{"id":2473,"name":"version","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current version of your CLI program. Typically the version found in your "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":". This is output when "},{"kind":"code","text":"`--version`"},{"kind":"text","text":" is passed."}]},"sources":[{"fileName":"packages/cli/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/types.ts#L90"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2278,"name":"ProgramOptions.version"}}],"groups":[{"title":"Properties","children":[2467,2468,2466,2469,2470,2471,2472,2473]}],"sources":[{"fileName":"packages/cli/src/components/IndexHelp.tsx","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/IndexHelp.tsx#L7"}],"extendedTypes":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"permalink":"/api/cli-react/interface/IndexHelpProps","previousId":2450,"nextId":2477},{"id":2477,"name":"InputProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2478,"name":"defaultValue","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A default value. If none provided, will use an empty state."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L9"}],"type":{"type":"intrinsic","name":"string"}},{"id":2479,"name":"hideCursor","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Hide the cursor in the terminal. Will remove the background color, but still functions."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L11"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2486,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label to display before or above the prompt itself."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.label"}},{"id":2480,"name":"mask","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mask to replace every inputted character with."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L13"}],"type":{"type":"intrinsic","name":"string"}},{"id":2481,"name":"onChange","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value changes."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L15"}],"type":{"type":"reflection","declaration":{"id":2482,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L15"}],"signatures":[{"id":2483,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value changes."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L15"}],"parameters":[{"id":2484,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2488,"name":"onSubmit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"type":{"type":"reflection","declaration":{"id":2489,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"signatures":[{"id":2490,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"parameters":[{"id":2491,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.onSubmit"}},{"id":2485,"name":"placeholder","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom string to display when the value is empty and non-dirty."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L17"}],"type":{"type":"intrinsic","name":"string"}},{"id":2487,"name":"prefix","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character symbol to display before the label. Defaults to \\"?\\"\\"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L14"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.prefix"}},{"id":2492,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"type":{"type":"reflection","declaration":{"id":2493,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"signatures":[{"id":2494,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"parameters":[{"id":2495,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.validate"}}],"groups":[{"title":"Properties","children":[2478,2479,2486,2480,2481,2488,2485,2487,2492]}],"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L7"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/Prompt.tsx","qualifiedName":"PromptProps"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"PromptProps","package":"@boost/cli"}],"permalink":"/api/cli-react/interface/InputProps","previousId":2465,"nextId":2500},{"id":2500,"name":"MultiSelectProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2501,"name":"defaultSelected","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of option values selected by default."}]},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L15"}],"type":{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}},"overwrites":{"type":"reference","target":2549,"name":"SelectProps.defaultSelected"}},{"id":2507,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label to display before or above the prompt itself."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"},"inheritedFrom":{"type":"reference","target":2551,"name":"SelectProps.label"}},{"id":2517,"name":"limit","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Number of options to display before scrolling. Defaults to console height."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L16"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":2561,"name":"SelectProps.limit"}},{"id":2502,"name":"onChange","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback triggered when a value is selected or unselected."}]},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L17"}],"type":{"type":"reflection","declaration":{"id":2503,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":17,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L17"}],"signatures":[{"id":2504,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when a value is selected or unselected."}]},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":17,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L17"}],"parameters":[{"id":2505,"name":"values","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2509,"name":"onSubmit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"type":{"type":"reflection","declaration":{"id":2510,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"signatures":[{"id":2511,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"parameters":[{"id":2512,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":2553,"name":"SelectProps.onSubmit"}},{"id":2506,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of options to choose from. Can either be a string, number, or object with a "},{"kind":"code","text":"`label`"},{"kind":"text","text":" and "},{"kind":"code","text":"`value`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L27"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true},{"type":"reference","target":2534,"typeArguments":[{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}],"name":"SelectOptionLike","package":"@boost/cli"}]}},"inheritedFrom":{"type":"reference","target":2550,"name":"SelectProps.options"}},{"id":2518,"name":"overflowAfterLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label to display above scrollable options with the number of overflowing options."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"OverflowLabel"},"name":"OverflowLabel","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":2562,"name":"SelectProps.overflowAfterLabel"}},{"id":2519,"name":"overflowBeforeLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label to display below scrollable options with the number of overflowing options."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L20"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"OverflowLabel"},"name":"OverflowLabel","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":2563,"name":"SelectProps.overflowBeforeLabel"}},{"id":2508,"name":"prefix","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character symbol to display before the label. Defaults to \\"?\\"\\"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L14"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2552,"name":"SelectProps.prefix"}},{"id":2520,"name":"scrollType","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The pattern in which to limit options when scrolling. Defaults to "},{"kind":"code","text":"`overflow`"},{"kind":"text","text":".\\n- "},{"kind":"code","text":"`cycle`"},{"kind":"text","text":" - Will continously cycle through options, even when navigating to and past edges.\\n- "},{"kind":"code","text":"`overflow`"},{"kind":"text","text":" - Will display options bound to an edge, with the number of options hidden above and below."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L26"}],"type":{"type":"union","types":[{"type":"literal","value":"cycle"},{"type":"literal","value":"overflow"}]},"inheritedFrom":{"type":"reference","target":2564,"name":"SelectProps.scrollType"}},{"id":2513,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"type":{"type":"reflection","declaration":{"id":2514,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"signatures":[{"id":2515,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"parameters":[{"id":2516,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":2557,"name":"SelectProps.validate"}}],"groups":[{"title":"Properties","children":[2501,2507,2517,2502,2509,2506,2518,2519,2508,2520,2513]}],"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":13,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L13"}],"typeParameters":[{"id":2521,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"extendedTypes":[{"type":"reference","target":2548,"typeArguments":[{"type":"array","elementType":{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}},{"type":"reference","target":2521,"name":"T","package":"@boost/cli","qualifiedName":"MultiSelectProps.T","refersToTypeParameter":true}],"name":"SelectProps","package":"@boost/cli"}],"permalink":"/api/cli-react/interface/MultiSelectProps","previousId":2477,"nextId":2542},{"id":2542,"name":"SelectOption","variant":"declaration","kind":256,"flags":{},"children":[{"id":2543,"name":"divider","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L17"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2544,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L18"}],"type":{"type":"intrinsic","name":"number"}},{"id":2545,"name":"label","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L19"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"}},{"id":2546,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L20"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":2547,"name":"T","package":"@boost/cli","qualifiedName":"SelectOption.T","refersToTypeParameter":true}]}}],"groups":[{"title":"Properties","children":[2543,2544,2545,2546]}],"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":16,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L16"}],"typeParameters":[{"id":2547,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/cli-react/interface/SelectOption","previousId":2500,"nextId":2548},{"id":2548,"name":"SelectProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2549,"name":"defaultSelected","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Option value selected by default."}]},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L25"}],"type":{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}},{"id":2551,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Label to display before or above the prompt itself."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.label"}},{"id":2561,"name":"limit","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Number of options to display before scrolling. Defaults to console height."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L16"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":-1,"name":"ScrollableListProps.limit"}},{"id":2553,"name":"onSubmit","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"type":{"type":"reflection","declaration":{"id":2554,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"signatures":[{"id":2555,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Callback triggered when the value is submitted."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":16,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L16"}],"parameters":[{"id":2556,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.onSubmit"}},{"id":2550,"name":"options","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of options to choose from. Can either be a string, number, or object with a "},{"kind":"code","text":"`label`"},{"kind":"text","text":" and "},{"kind":"code","text":"`value`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L27"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","target":2566,"name":"V","package":"@boost/cli","qualifiedName":"SelectProps.V","refersToTypeParameter":true},{"type":"reference","target":2534,"typeArguments":[{"type":"reference","target":2566,"name":"V","package":"@boost/cli","qualifiedName":"SelectProps.V","refersToTypeParameter":true}],"name":"SelectOptionLike","package":"@boost/cli"}]}}},{"id":2562,"name":"overflowAfterLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label to display above scrollable options with the number of overflowing options."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"OverflowLabel"},"name":"OverflowLabel","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"ScrollableListProps.overflowAfterLabel"}},{"id":2563,"name":"overflowBeforeLabel","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Label to display below scrollable options with the number of overflowing options."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L20"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"OverflowLabel"},"name":"OverflowLabel","package":"@boost/cli"},"inheritedFrom":{"type":"reference","target":-1,"name":"ScrollableListProps.overflowBeforeLabel"}},{"id":2552,"name":"prefix","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Single character symbol to display before the label. Defaults to \\"?\\"\\"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L14"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.prefix"}},{"id":2564,"name":"scrollType","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"The pattern in which to limit options when scrolling. Defaults to "},{"kind":"code","text":"`overflow`"},{"kind":"text","text":".\\n- "},{"kind":"code","text":"`cycle`"},{"kind":"text","text":" - Will continously cycle through options, even when navigating to and past edges.\\n- "},{"kind":"code","text":"`overflow`"},{"kind":"text","text":" - Will display options bound to an edge, with the number of options hidden above and below."}]},"sources":[{"fileName":"packages/cli/src/components/internal/ScrollableList.tsx","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/ScrollableList.tsx#L26"}],"type":{"type":"union","types":[{"type":"literal","value":"cycle"},{"type":"literal","value":"overflow"}]},"inheritedFrom":{"type":"reference","target":-1,"name":"ScrollableListProps.scrollType"}},{"id":2557,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"type":{"type":"reflection","declaration":{"id":2558,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"signatures":[{"id":2559,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Function to validate the value on submit. To trigger a failed state, thrown an "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/internal/Prompt.tsx","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/internal/Prompt.tsx#L18"}],"parameters":[{"id":2560,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":-1,"name":"PromptProps.validate"}}],"groups":[{"title":"Properties","children":[2549,2551,2561,2553,2550,2562,2563,2552,2564,2557]}],"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":23,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L23"}],"typeParameters":[{"id":2565,"name":"T","variant":"typeParam","kind":131072,"flags":{}},{"id":2566,"name":"V","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/Prompt.tsx","qualifiedName":"PromptProps"},"typeArguments":[{"type":"reference","target":2565,"name":"T","package":"@boost/cli","qualifiedName":"SelectProps.T","refersToTypeParameter":true}],"name":"PromptProps","package":"@boost/cli"},{"type":"reference","target":{"sourceFileName":"../packages/cli/src/components/internal/ScrollableList.tsx","qualifiedName":"ScrollableListProps"},"name":"ScrollableListProps","package":"@boost/cli"}],"extendedBy":[{"type":"reference","target":2500,"name":"MultiSelectProps"}],"permalink":"/api/cli-react/interface/SelectProps","previousId":2542,"nextId":2570},{"id":2570,"name":"StyleProps","variant":"declaration","kind":256,"flags":{},"children":[{"id":2571,"name":"children","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"}},{"id":2572,"name":"inverted","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Invert the colors to style the background instead of foreground. Defaults\\nto "},{"kind":"code","text":"`false`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L10"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2573,"name":"type","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Theme palette name to style with. Defaults to \\"none\\"."}]},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L12"}],"type":{"type":"union","types":[{"type":"reference","target":2400,"name":"StyleType","package":"@boost/cli"},{"type":"literal","value":"none"}]}}],"groups":[{"title":"Properties","children":[2571,2572,2573]}],"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":6,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L6"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Pick"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/ink/build/components/Text.d.ts","qualifiedName":"Props"},"name":"TextProps","package":"ink","qualifiedName":"Props"},{"type":"union","types":[{"type":"literal","value":"bold"},{"type":"literal","value":"italic"},{"type":"literal","value":"underline"},{"type":"literal","value":"wrap"}]}],"name":"Pick","package":"typescript"}],"permalink":"/api/cli-react/interface/StyleProps","previousId":2548,"nextId":2461},{"id":2461,"name":"HiddenInputProps","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/components/HiddenInput.tsx","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/HiddenInput.tsx#L3"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2477,"name":"InputProps","package":"@boost/cli"},{"type":"union","types":[{"type":"literal","value":"hideCursor"},{"type":"literal","value":"mask"}]}],"name":"Omit","package":"typescript"},"permalink":"/api/cli-react#HiddenInputProps","previousId":2570,"nextId":2525},{"id":2525,"name":"PasswordInputProps","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/components/PasswordInput.tsx","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/PasswordInput.tsx#L3"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":2477,"name":"InputProps","package":"@boost/cli"},{"type":"literal","value":"mask"}],"name":"Omit","package":"typescript"},"permalink":"/api/cli-react#PasswordInputProps","previousId":2461,"nextId":2534},{"id":2534,"name":"SelectOptionLike","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":12,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L12"}],"typeParameters":[{"id":2541,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"union","types":[{"type":"reflection","declaration":{"id":2535,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2536,"name":"divider","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":13,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L13"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2537,"name":"label","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":13,"character":23,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L13"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"}}],"groups":[{"title":"Properties","children":[2536,2537]}],"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":13,"character":3,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L13"}]}},{"type":"reflection","declaration":{"id":2538,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2539,"name":"label","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":14,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L14"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"NonNullable"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactNode"},"name":"ReactNode","package":"@types/react","qualifiedName":"React.ReactNode"}],"name":"NonNullable","package":"typescript"}},{"id":2540,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":14,"character":36,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L14"}],"type":{"type":"reference","target":2541,"name":"T","package":"@boost/cli","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[2539,2540]}],"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":14,"character":3,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L14"}]}}]},"permalink":"/api/cli-react#SelectOptionLike","previousId":2525,"nextId":2609},{"id":2609,"name":"ProgramContext","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/cli/src/ProgramContext.ts","line":5,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/ProgramContext.ts#L5"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.Context"},"typeArguments":[{"type":"reference","target":2283,"name":"ProgramContextType","package":"@boost/cli"}],"name":"Context","package":"@types/react","qualifiedName":"React.Context"},"defaultValue":"...","permalink":"/api/cli-react#ProgramContext","previousId":2534},{"id":2402,"name":"Confirm","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":22,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L22"}],"signatures":[{"id":2403,"name":"Confirm","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a yes/no confirmation prompt."}]},"sources":[{"fileName":"packages/cli/src/components/Confirm.tsx","line":22,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Confirm.tsx#L22"}],"parameters":[{"id":2404,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2405,"name":"ConfirmProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Confirm","previousId":2422,"nextId":2439},{"id":2439,"name":"Header","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L20"}],"signatures":[{"id":2440,"name":"Header","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a header/title within a terminal menu."}]},"sources":[{"fileName":"packages/cli/src/components/Header.tsx","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Header.tsx#L20"}],"parameters":[{"id":2441,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2442,"name":"HeaderProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Header","previousId":2402,"nextId":2447},{"id":2447,"name":"Help","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":52,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L52"}],"signatures":[{"id":2448,"name":"Help","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a help menu for a command.\\nIncludes all sub-commands, options, params, and more."}]},"sources":[{"fileName":"packages/cli/src/components/Help.tsx","line":52,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Help.tsx#L52"}],"parameters":[{"id":2449,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2450,"name":"HelpProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Help","previousId":2439,"nextId":2458},{"id":2458,"name":"HiddenInput","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/HiddenInput.tsx","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/HiddenInput.tsx#L8"}],"signatures":[{"id":2459,"name":"HiddenInput","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders an input field that hides its content from the terminal."}]},"sources":[{"fileName":"packages/cli/src/components/HiddenInput.tsx","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/HiddenInput.tsx#L8"}],"parameters":[{"id":2460,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2461,"name":"HiddenInputProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/HiddenInput","previousId":2447,"nextId":2462},{"id":2462,"name":"IndexHelp","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/IndexHelp.tsx","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/IndexHelp.tsx#L14"}],"signatures":[{"id":2463,"name":"IndexHelp","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a help menu for the entire program."}]},"sources":[{"fileName":"packages/cli/src/components/IndexHelp.tsx","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/IndexHelp.tsx#L14"}],"parameters":[{"id":2464,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2465,"name":"IndexHelpProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/IndexHelp","previousId":2458,"nextId":2474},{"id":2474,"name":"Input","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L23"}],"signatures":[{"id":2475,"name":"Input","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders an input field, allowing the user to enter information."}]},"sources":[{"fileName":"packages/cli/src/components/Input.tsx","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Input.tsx#L23"}],"parameters":[{"id":2476,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2477,"name":"InputProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Input","previousId":2462,"nextId":2496},{"id":2496,"name":"MultiSelect","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L24"}],"signatures":[{"id":2497,"name":"MultiSelect","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a select menu with options, where multiple options can be seleted.\\nOptions can be navigated with arrow keys, selected with \\"space\\", and submitted with \\"enter\\"."}]},"sources":[{"fileName":"packages/cli/src/components/MultiSelect.tsx","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/MultiSelect.tsx#L24"}],"typeParameter":[{"id":2498,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2499,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2500,"typeArguments":[{"type":"reference","target":2498,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"MultiSelectProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/MultiSelect","previousId":2474,"nextId":2522},{"id":2522,"name":"PasswordInput","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/PasswordInput.tsx","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/PasswordInput.tsx#L8"}],"signatures":[{"id":2523,"name":"PasswordInput","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders an input field with characters masked with \\"*\\"."}]},"sources":[{"fileName":"packages/cli/src/components/PasswordInput.tsx","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/PasswordInput.tsx#L8"}],"parameters":[{"id":2524,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2525,"name":"PasswordInputProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/PasswordInput","previousId":2496,"nextId":2530},{"id":2530,"name":"Select","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":55,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L55"}],"signatures":[{"id":2531,"name":"Select","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that renders a select menu with options, where a single option can be seleted.\\nOptions can be navigated with arrow keys, selected with \\"space\\", and submitted with \\"enter\\"."}]},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":55,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L55"}],"typeParameter":[{"id":2532,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":2533,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2548,"typeArguments":[{"type":"reference","target":2532,"name":"T","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":2532,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"SelectProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Select","previousId":2522,"nextId":2567},{"id":2567,"name":"Style","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":18,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L18"}],"signatures":[{"id":2568,"name":"Style","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A React component that styles text and backgrounds based on the current Boost theme."}]},"sources":[{"fileName":"packages/cli/src/components/Style.tsx","line":18,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Style.tsx#L18"}],"parameters":[{"id":2569,"name":"props","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2570,"name":"StyleProps","package":"@boost/cli"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/jsx-runtime.d.ts","qualifiedName":"JSX.Element"},"name":"Element","package":"@types/react","qualifiedName":"JSX.Element"}}],"permalink":"/api/cli-react/function/Style","previousId":2530,"nextId":2526},{"id":2526,"name":"normalizeOptions","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":30,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L30"}],"signatures":[{"id":2527,"name":"normalizeOptions","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/components/Select.tsx","line":30,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/components/Select.tsx#L30"}],"typeParameter":[{"id":2528,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2529,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"array","elementType":{"type":"reference","target":2542,"typeArguments":[{"type":"reference","target":2528,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"SelectOption","package":"@boost/cli"}}}],"permalink":"/api/cli-react/function/normalizeOptions","previousId":2567,"nextId":2574},{"id":2574,"name":"useDimensions","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}],"signatures":[{"id":2575,"name":"useDimensions","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}],"type":{"type":"reflection","declaration":{"id":2576,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2577,"name":"height","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}],"type":{"type":"intrinsic","name":"number"}},{"id":2578,"name":"width","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":51,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[2577,2578]}],"sources":[{"fileName":"packages/cli/src/hooks/useDimensions.ts","line":5,"character":33,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useDimensions.ts#L5"}]}}}],"permalink":"/api/cli-react/function/useDimensions","previousId":2526,"nextId":2579},{"id":2579,"name":"useIsMounted","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useIsMounted.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useIsMounted.ts#L3"}],"signatures":[{"id":2580,"name":"useIsMounted","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useIsMounted.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useIsMounted.ts#L3"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.MutableRefObject"},"typeArguments":[{"type":"intrinsic","name":"boolean"}],"name":"MutableRefObject","package":"@types/react","qualifiedName":"React.MutableRefObject"}}],"permalink":"/api/cli-react/function/useIsMounted","previousId":2574,"nextId":2581},{"id":2581,"name":"useListNavigation","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L3"}],"signatures":[{"id":2582,"name":"useListNavigation","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":3,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L3"}],"parameters":[{"id":2583,"name":"list","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reflection","declaration":{"id":2584,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2585,"name":"disabled","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":4,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L4"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2586,"name":"divider","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":4,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L4"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2585,2586]}],"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":4,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L4"}]}}}},{"id":2587,"name":"defaultIndex","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reflection","declaration":{"id":2588,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":2589,"name":"highlightedIndex","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":48,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L48"}],"type":{"type":"intrinsic","name":"number"}},{"id":2590,"name":"onKeyDown","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":49,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L49"}],"type":{"type":"reflection","declaration":{"id":2591,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":31,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L31"}],"signatures":[{"id":2592,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":31,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L31"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2593,"name":"onKeyLeft","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":50,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L50"}],"type":{"type":"reflection","declaration":{"id":2594,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":39,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L39"}],"signatures":[{"id":2595,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":39,"character":31,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L39"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2596,"name":"onKeyRight","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":51,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L51"}],"type":{"type":"reflection","declaration":{"id":2597,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":43,"character":32,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L43"}],"signatures":[{"id":2598,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":43,"character":32,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L43"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":2599,"name":"onKeyUp","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":52,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L52"}],"type":{"type":"reflection","declaration":{"id":2600,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":35,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L35"}],"signatures":[{"id":2601,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":35,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L35"}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[2589,2590,2593,2596,2599]}],"sources":[{"fileName":"packages/cli/src/hooks/useListNavigation.ts","line":47,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useListNavigation.ts#L47"}]}}}],"permalink":"/api/cli-react/function/useListNavigation","previousId":2579,"nextId":2602},{"id":2602,"name":"useProgram","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useProgram.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useProgram.ts#L8"}],"signatures":[{"id":2603,"name":"useProgram","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useProgram.ts","line":8,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useProgram.ts#L8"}],"type":{"type":"reference","target":2283,"name":"ProgramContextType","package":"@boost/cli"}}],"permalink":"/api/cli-react/function/useProgram","previousId":2581,"nextId":2604},{"id":2604,"name":"useRenderLoop","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useRenderLoop.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useRenderLoop.ts#L5"}],"signatures":[{"id":2605,"name":"useRenderLoop","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useRenderLoop.ts","line":5,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useRenderLoop.ts#L5"}],"parameters":[{"id":2606,"name":"fps","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"},"defaultValue":"30"}],"type":{"type":"reflection","declaration":{"id":2607,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/hooks/useRenderLoop.ts","line":5,"character":49,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/hooks/useRenderLoop.ts#L5"}],"signatures":[{"id":2608,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"void"}}]}}}],"permalink":"/api/cli-react/function/useRenderLoop","previousId":2602,"nextId":2405}],"groups":[{"title":"Classes","children":[2422]},{"title":"Functions","children":[2402,2439,2447,2458,2462,2474,2496,2522,2530,2567,2526,2574,2579,2581,2602,2604]},{"title":"Interfaces","children":[2405,2415,2442,2450,2465,2477,2500,2542,2548,2570]},{"title":"Type Aliases","children":[2461,2525,2534]},{"title":"Variables","children":[2609]}],"sources":[{"fileName":"packages/cli/src/react.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/react.ts#L1"}],"permalink":"/api/cli-react"},"urlSlug":"cli-react"},{"index":false,"label":"Test utilities","reflection":{"id":11,"name":"@boost/cli/test","variant":"declaration","kind":2,"flags":{},"children":[{"id":54,"name":"MockReadStream","variant":"declaration","kind":128,"flags":{},"children":[{"id":55,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":56,"name":"new MockReadStream","variant":"signature","kind":16384,"flags":{},"type":{"type":"reference","target":54,"name":"MockReadStream","package":"@boost/cli"}}]},{"id":57,"name":"isTTY","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L20"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"groups":[{"title":"Constructors","children":[55]},{"title":"Properties","children":[57]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":19,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L19"}],"permalink":"/api/cli-test/class/MockReadStream","nextId":58},{"id":58,"name":"MockWriteStream","variant":"declaration","kind":128,"flags":{},"children":[{"id":59,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L30"}],"signatures":[{"id":60,"name":"new MockWriteStream","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L30"}],"parameters":[{"id":61,"name":"append","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"reference","target":58,"name":"MockWriteStream","package":"@boost/cli"}}]},{"id":62,"name":"append","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L24"}],"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"},{"id":63,"name":"columns","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L26"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"80"},{"id":64,"name":"output","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L28"}],"type":{"type":"intrinsic","name":"string"}},{"id":68,"name":"get","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L43"}],"signatures":[{"id":69,"name":"get","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L43"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":72,"name":"off","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":49,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L49"}],"signatures":[{"id":73,"name":"off","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":49,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L49"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":70,"name":"on","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L47"}],"signatures":[{"id":71,"name":"on","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L47"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":65,"name":"write","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L35"}],"signatures":[{"id":66,"name":"write","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L35"}],"parameters":[{"id":67,"name":"string","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Constructors","children":[59]},{"title":"Properties","children":[62,63,64]},{"title":"Methods","children":[68,72,70,65]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":23,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L23"}],"permalink":"/api/cli-test/class/MockWriteStream","previousId":54,"nextId":15},{"id":15,"name":"mockProgram","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L80"}],"signatures":[{"id":16,"name":"mockProgram","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a "},{"kind":"code","text":"`Program`"},{"kind":"text","text":" instance with required options pre-filled and streams mocked\\n(unless manually provided).\\n\\n"},{"kind":"code","text":"```ts\\nimport { mockProgram } from \'@boost/cli/test\';\\n\\nconst program = mockProgram({ name: \'Example\' });\\n```"}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L80"}],"parameters":[{"id":17,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2271,"name":"ProgramOptions","package":"@boost/cli"}],"name":"Partial","package":"typescript"}},{"id":18,"name":"streams","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2279,"name":"ProgramStreams","package":"@boost/cli"}}],"type":{"type":"reference","target":2033,"name":"Program","package":"@boost/cli"}}],"permalink":"/api/cli-test/function/mockProgram","previousId":58,"nextId":12},{"id":12,"name":"mockStreams","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":62,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L62"}],"signatures":[{"id":13,"name":"mockStreams","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns mocked "},{"kind":"code","text":"`stderr`"},{"kind":"text","text":", "},{"kind":"code","text":"`stdout`"},{"kind":"text","text":", and "},{"kind":"code","text":"`stdin`"},{"kind":"text","text":" streams that can be passed to a "},{"kind":"code","text":"`Program`"},{"kind":"text","text":".\\nThis does not mock all stream functionality, only those required by Boost and Ink.\\n\\n"},{"kind":"code","text":"```ts\\nimport { mockStreams } from \'@boost/cli/test\';\\n\\nconst streams = mockStreams();\\n```"}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":62,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L62"}],"parameters":[{"id":14,"name":"append","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":2279,"name":"ProgramStreams","package":"@boost/cli"}}],"permalink":"/api/cli-test/function/mockStreams","previousId":15,"nextId":19},{"id":19,"name":"renderComponent","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":109,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L109"}],"signatures":[{"id":20,"name":"renderComponent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to render a React component with Ink and return the rendered result\\nas a terminal compatible string. If "},{"kind":"code","text":"`stripped`"},{"kind":"text","text":" is true, it will strip ANSI\\nescape escape sequences.\\n\\n"},{"kind":"code","text":"```tsx\\nimport { renderComponent } from \'@boost/cli/test\';\\nimport TestComponent from \'../src/components/TestComponent\';\\n\\nit(\'renders a component\', async () => {\\n\\texpect(await renderComponent()).toMatchSnapshot();\\n});\\n```"},{"kind":"text","text":"\\n\\n> As an alternative, we also suggest using the official\\n> [ink-testing-library](https://github.com/vadimdemedes/ink-testing-library)."}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":109,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L109"}],"parameters":[{"id":21,"name":"element","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.ReactElement"},"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/@types/react/index.d.ts","qualifiedName":"React.JSXElementConstructor"},"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"JSXElementConstructor","package":"@types/react","qualifiedName":"React.JSXElementConstructor"}]}],"name":"ReactElement","package":"@types/react","qualifiedName":"React.ReactElement"}},{"id":22,"name":"stripped","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/cli-test/function/renderComponent","previousId":12,"nextId":23},{"id":23,"name":"runCommand","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":155,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L155"}],"signatures":[{"id":24,"name":"runCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Runs a "},{"kind":"code","text":"`Command`"},{"kind":"text","text":" outside the context of a "},{"kind":"code","text":"`Program`"},{"kind":"text","text":", but mimics similar functionality,\\nincluding React component rendering. Params are required as they\'re passed to the run method,\\nwhile options are optional and assume class properties have been defined. Also, the "},{"kind":"code","text":"`exit`"},{"kind":"text","text":"\\nand "},{"kind":"code","text":"`log`"},{"kind":"text","text":" methods have been mocked with Vitest spies so that they can be asserted.\\n\\n"},{"kind":"code","text":"```ts\\nimport { runCommand } from \'@boost/cli/test\';\\nimport TestCommand from \'../src/commands/TestCommand\';\\n\\nit(\'runs a command\', async () => {\\n\\tconst command = new TestCommand();\\n\\n\\texpect(await runCommand(command, [\'foo\', \'bar\', \'baz\'])).toMatchSnapshot();\\n\\texpect(command.log).toHaveBeenCalled();\\n});\\n```"},{"kind":"text","text":"\\n\\n> Since there is no "},{"kind":"code","text":"`Program`"},{"kind":"text","text":" context, any functionality that requires a program will fail. If\\n> needed, use "},{"kind":"code","text":"`runProgram()`"},{"kind":"text","text":" instead."}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":155,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L155"}],"typeParameter":[{"id":25,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2256,"name":"GlobalOptions","package":"@boost/cli"}},{"id":26,"name":"P","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2229,"name":"PrimitiveType","package":"@boost/args"}}}],"parameters":[{"id":27,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1851,"typeArguments":[{"type":"reference","target":25,"name":"O","package":"@boost/cli","refersToTypeParameter":true},{"type":"reference","target":26,"name":"P","package":"@boost/cli","refersToTypeParameter":true},{"type":"reflection","declaration":{"id":28,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Command","package":"@boost/cli"}},{"id":29,"name":"params","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":26,"name":"P","package":"@boost/cli","refersToTypeParameter":true}},{"id":30,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":25,"name":"O","package":"@boost/cli","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/cli-test/function/runCommand","previousId":19,"nextId":43},{"id":43,"name":"runProgram","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":261,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L261"}],"signatures":[{"id":44,"name":"runProgram","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Runs a "},{"kind":"code","text":"`Program`"},{"kind":"text","text":" as if it were ran on the command line, including middleware,\\ncommands, success and failure states, and more. Utilizes mocked streams to capture\\nand return standard output and ANSI stripped output. Failed runs will not throw\\nand instead will render a failure output.\\n\\n"},{"kind":"code","text":"```ts\\nimport { runProgram } from \'@boost/cli/test\';\\nimport Program from \'../src/program\';\\n\\nit(\'runs a program\', async () => {\\n\\tconst program = new Program();\\n\\n\\tconst { code, output } = await runProgram(program, [\'cmd\', \'--foo\', \'123\', \'bar\']);\\n\\n\\texpect(output).toMatchSnapshot();\\n\\texpect(code).toBe(0);\\n});\\n```"}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":261,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L261"}],"parameters":[{"id":45,"name":"program","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2033,"name":"Program","package":"@boost/cli"}},{"id":46,"name":"argv","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":47,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":48,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":49,"name":"append","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/cli/src/test.ts","line":264,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L264"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[49]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":264,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L264"}]}},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reflection","declaration":{"id":50,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":51,"name":"code","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":265,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L265"}],"type":{"type":"reference","target":2265,"name":"ExitCode","package":"@boost/cli"}},{"id":52,"name":"output","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":265,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L265"}],"type":{"type":"intrinsic","name":"string"}},{"id":53,"name":"outputStripped","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":265,"character":45,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L265"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[51,52,53]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":265,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L265"}]}}],"name":"Promise","package":"typescript"}}],"permalink":"/api/cli-test/function/runProgram","previousId":23,"nextId":31},{"id":31,"name":"runTask","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":208,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L208"}],"signatures":[{"id":32,"name":"runTask","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Runs a task function outside the context of a "},{"kind":"code","text":"`Command`"},{"kind":"text","text":", in complete isolation.\\nA mock command context is provided with standard defaults, and can be customized\\nthrough the 3rd argument.\\n\\n"},{"kind":"code","text":"```ts\\nimport { runTask } from \'@boost/cli/test\';\\nimport testTask from \'../src/tasks/testTask\';\\n\\nit(\'runs a task\', async () => {\\n\\tconst context = {\\n\\t\\tlog: vi.fn(),\\n\\t};\\n\\n\\texpect(await runTask(testTask, [\'foo\', \'bar\', \'baz\'], context)).toMatchSnapshot();\\n\\texpect(context.log).toHaveBeenCalled();\\n});\\n```"}]},"sources":[{"fileName":"packages/cli/src/test.ts","line":208,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L208"}],"typeParameter":[{"id":33,"name":"A","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":34,"name":"R","variant":"typeParam","kind":131072,"flags":{}},{"id":35,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2367,"name":"TaskContext","package":"@boost/cli"}}],"parameters":[{"id":36,"name":"task","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":37,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":209,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L209"}],"signatures":[{"id":38,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/cli/src/test.ts","line":209,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L209"}],"parameters":[{"id":39,"name":"this","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":35,"name":"T","package":"@boost/cli","refersToTypeParameter":true}},{"id":40,"name":"argz","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":33,"name":"A","package":"@boost/cli","refersToTypeParameter":true}}],"type":{"type":"reference","target":34,"name":"R","package":"@boost/cli","refersToTypeParameter":true}}]}}},{"id":41,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":33,"name":"A","package":"@boost/cli","refersToTypeParameter":true}},{"id":42,"name":"context","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":35,"name":"T","package":"@boost/cli","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":34,"name":"R","package":"@boost/cli","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}],"permalink":"/api/cli-test/function/runTask","previousId":43}],"groups":[{"title":"Classes","children":[54,58]},{"title":"Functions","children":[15,12,19,23,43,31]}],"sources":[{"fileName":"packages/cli/src/test.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/cli/src/test.ts#L1"}],"permalink":"/api/cli-test"},"urlSlug":"cli-test"}],"packageName":"@boost/cli","packageVersion":"5.0.0-alpha.3"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":74,"name":"@boost/common","variant":"declaration","kind":2,"flags":{},"children":[{"id":2610,"name":"json","variant":"declaration","kind":4,"flags":{},"children":[{"id":2629,"name":"JSONStringifyOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2631,"name":"quote","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L9"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"}]}},{"id":2632,"name":"replacer","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L10"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}},{"type":"reflection","declaration":{"id":2633,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":10,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L10"}],"signatures":[{"id":2634,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":10,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L10"}],"parameters":[{"id":2635,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2636,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"unknown"}}]}}]}},{"id":2630,"name":"space","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L8"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"}]}}],"groups":[{"title":"Properties","children":[2631,2632,2630]}],"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L7"}],"permalink":"/api/common/namespace/json#JSONStringifyOptions"},{"id":2624,"name":"JSONReviver","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L5"}],"type":{"type":"reflection","declaration":{"id":2625,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":5,"character":26,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L5"}],"signatures":[{"id":2626,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2627,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2628,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"unknown"}}]}},"permalink":"/api/common/namespace/json#JSONReviver"},{"id":2620,"name":"load","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L21"}],"signatures":[{"id":2621,"name":"load","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L21"}],"typeParameter":[{"id":2622,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2623,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2622,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/namespace/json#load"},{"id":2611,"name":"parse","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L13"}],"signatures":[{"id":2612,"name":"parse","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L13"}],"typeParameter":[{"id":2613,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2614,"name":"content","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2615,"name":"reviver","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2624,"name":"JSONReviver","package":"@boost/common"}}],"type":{"type":"reference","target":2613,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/namespace/json#parse"},{"id":2616,"name":"stringify","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L17"}],"signatures":[{"id":2617,"name":"stringify","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L17"}],"parameters":[{"id":2618,"name":"content","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":2619,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2629,"name":"JSONStringifyOptions","package":"@boost/common"},"defaultValue":"{}"}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/common/namespace/json#stringify"}],"groups":[{"title":"Interfaces","children":[2629]},{"title":"Type Aliases","children":[2624]},{"title":"Functions","children":[2620,2611,2616]}],"sources":[{"fileName":"packages/common/src/serializers/json.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/json.ts#L1"}],"permalink":"/api/common/namespace/json","previousId":3051,"nextId":2637},{"id":2637,"name":"yaml","variant":"declaration","kind":4,"flags":{},"children":[{"id":2647,"name":"load","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":27,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L27"}],"signatures":[{"id":2648,"name":"load","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":27,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L27"}],"typeParameter":[{"id":2649,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":2650,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2649,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/namespace/yaml#load"},{"id":2638,"name":"parse","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L13"}],"signatures":[{"id":2639,"name":"parse","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L13"}],"typeParameter":[{"id":2640,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2641,"name":"content","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2642,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"DocumentOptions"},"name":"DocumentOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"ParseOptions"},"name":"ParseOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"SchemaOptions"},"name":"SchemaOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"ToJSOptions"},"name":"ToJSOptions","package":"yaml"}]}}],"type":{"type":"reference","target":2640,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/namespace/yaml#parse"},{"id":2643,"name":"stringify","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L20"}],"signatures":[{"id":2644,"name":"stringify","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L20"}],"parameters":[{"id":2645,"name":"content","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":2646,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"CreateNodeOptions"},"name":"CreateNodeOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"DocumentOptions"},"name":"DocumentOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"ParseOptions"},"name":"ParseOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"SchemaOptions"},"name":"SchemaOptions","package":"yaml"},{"type":"reference","target":{"sourceFileName":"../node_modules/yaml/dist/options.d.ts","qualifiedName":"ToStringOptions"},"name":"ToStringOptions","package":"yaml"}]}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/common/namespace/yaml#stringify"}],"groups":[{"title":"Functions","children":[2647,2638,2643]}],"sources":[{"fileName":"packages/common/src/serializers/yaml.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/serializers/yaml.ts#L1"}],"permalink":"/api/common/namespace/yaml","previousId":2610,"nextId":2937},{"id":2659,"name":"Contract","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":2660,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L8"}],"signatures":[{"id":2661,"name":"new Contract","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L8"}],"typeParameter":[{"id":2662,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":2663,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":2664,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}}],"type":{"type":"reference","target":2659,"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}}]},{"id":2665,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/src/Contract.ts","line":6,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L6"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"implementationOf":{"type":"reference","target":2956,"name":"Optionable.options"}},{"id":2672,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting."}]},"sources":[{"fileName":"packages/common/src/Contract.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L51"}],"signatures":[{"id":2673,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/src/Contract.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L51"}],"parameters":[{"id":2674,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":2675,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"implementationOf":{"type":"reference","target":-1,"name":"Optionable.blueprint"}}],"implementationOf":{"type":"reference","target":2957,"name":"Optionable.blueprint"}},{"id":2666,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L28"}],"signatures":[{"id":2667,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/src/Contract.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L28"}],"parameters":[{"id":2668,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":2669,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":28,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L28"}],"signatures":[{"id":2670,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":28,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L28"}],"parameters":[{"id":2671,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[2660]},{"title":"Properties","children":[2665]},{"title":"Methods","children":[2672,2666]}],"sources":[{"fileName":"packages/common/src/Contract.ts","line":4,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L4"}],"typeParameters":[{"id":2676,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":2677,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/Contract.ts","line":4,"character":50,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Contract.ts#L4"}]}}}],"implementedTypes":[{"type":"reference","target":2955,"typeArguments":[{"type":"reference","target":2662,"name":"T","package":"@boost/common","qualifiedName":"Contract.T","refersToTypeParameter":true}],"name":"Optionable","package":"@boost/common"}],"permalink":"/api/common/class/Contract","nextId":2678},{"id":2678,"name":"ExitError","variant":"declaration","kind":128,"flags":{},"children":[{"id":2679,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/ExitError.ts","line":4,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ExitError.ts#L4"}],"signatures":[{"id":2680,"name":"new ExitError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/ExitError.ts","line":4,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ExitError.ts#L4"}],"parameters":[{"id":2681,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2682,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":2678,"name":"ExitError","package":"@boost/common"},"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Error.constructor"}},{"id":2683,"name":"code","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/ExitError.ts","line":2,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ExitError.ts#L2"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Constructors","children":[2679]},{"title":"Properties","children":[2683]}],"sources":[{"fileName":"packages/common/src/ExitError.ts","line":1,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ExitError.ts#L1"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}],"permalink":"/api/common/class/ExitError","previousId":2659,"nextId":2735},{"id":2735,"name":"ModulePath","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"An immutable class for operating on Node.js module IDs, names, and paths."}]},"children":[{"id":2742,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L12"}],"signatures":[{"id":2743,"name":"new ModulePath","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L12"}],"parameters":[{"id":2744,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2735,"name":"ModulePath","package":"@boost/common"}}]},{"id":2747,"name":"append","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L34"}],"signatures":[{"id":2748,"name":"append","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Append path parts to the end of the current path\\nand return a new "},{"kind":"code","text":"`ModulePath`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L34"}],"parameters":[{"id":2749,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2735,"name":"ModulePath","package":"@boost/common"}}]},{"id":2750,"name":"hasScope","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L43"}],"signatures":[{"id":2751,"name":"hasScope","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the module is scoped within a private namespace\\n(starts with @)."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L43"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2752,"name":"name","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L51"}],"signatures":[{"id":2753,"name":"name","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the module name without any trailing import paths,\\nor optionally without the private scope."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L51"}],"parameters":[{"id":2754,"name":"withoutScope","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2755,"name":"path","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":64,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L64"}],"signatures":[{"id":2756,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the current module path as a normalized string."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":64,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L64"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2914,"name":"Pathable.path"}}],"implementationOf":{"type":"reference","target":2914,"name":"Pathable.path"}},{"id":2757,"name":"scope","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":79,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L79"}],"signatures":[{"id":2758,"name":"scope","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the private scope with leading @, or null if not defined."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":79,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L79"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"intrinsic","name":"string"}]}}]},{"id":2759,"name":"toJSON","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":87,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L87"}],"signatures":[{"id":2760,"name":"toJSON","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":87,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L87"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2761,"name":"toString","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L91"}],"signatures":[{"id":2762,"name":"toString","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L91"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2917,"name":"Pathable.toString"}}],"implementationOf":{"type":"reference","target":2917,"name":"Pathable.toString"}},{"id":2736,"name":"create","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":19,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L19"}],"signatures":[{"id":2737,"name":"create","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a new "},{"kind":"code","text":"`ModulePath`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":19,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L19"}],"parameters":[{"id":2738,"name":"id","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2735,"name":"ModulePath","package":"@boost/common"}}]},{"id":2739,"name":"path","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L26"}],"signatures":[{"id":2740,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a module path-like value to a formatted module path string."}]},"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L26"}],"parameters":[{"id":2741,"name":"part","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"string"}}]}],"groups":[{"title":"Constructors","children":[2742]},{"title":"Methods","children":[2747,2750,2752,2755,2757,2759,2761,2736,2739]}],"sources":[{"fileName":"packages/common/src/ModulePath.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/ModulePath.ts#L7"}],"implementedTypes":[{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}],"permalink":"/api/common/class/ModulePath","previousId":2678,"nextId":2763},{"id":2763,"name":"PackageGraph","variant":"declaration","kind":128,"flags":{},"children":[{"id":2764,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L24"}],"signatures":[{"id":2765,"name":"new PackageGraph","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L24"}],"typeParameter":[{"id":2766,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"},"default":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"parameters":[{"id":2767,"name":"packages","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}},"defaultValue":"[]"}],"type":{"type":"reference","target":2763,"typeArguments":[{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}],"name":"PackageGraph","package":"@boost/common"}}]},{"id":2771,"name":"addPackage","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L33"}],"signatures":[{"id":2772,"name":"addPackage","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a package by name with an associated "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" object.\\nWill map a dependency between the package and its dependees\\nfound in "},{"kind":"code","text":"`dependencies`"},{"kind":"text","text":" and "},{"kind":"code","text":"`peerDependencies`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L33"}],"parameters":[{"id":2773,"name":"pkg","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2774,"name":"addPackages","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L50"}],"signatures":[{"id":2775,"name":"addPackages","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add multiple packages."}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L50"}],"parameters":[{"id":2776,"name":"packages","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}},"defaultValue":"[]"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2781,"name":"resolveBatchList","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L153"}],"signatures":[{"id":2782,"name":"resolveBatchList","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the dependency graph and return a list of batched "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" objects\\n(array of arrays) in the order they are depended on.\\n\\n"},{"kind":"code","text":"```ts\\ngraph.resolveBatchList().forEach((pkgs) => {\\n\\tpkgs.forEach((pkg) => {\\n\\t\\tconsole.log(pkg.name);\\n\\t});\\n});\\n```"}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L153"}],"type":{"type":"array","elementType":{"type":"array","elementType":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}}}}]},{"id":2777,"name":"resolveList","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":68,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L68"}],"signatures":[{"id":2778,"name":"resolveList","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the dependency graph and return a list of all\\n"},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" objects in the order they are depended on.\\n\\n"},{"kind":"code","text":"```ts\\ngraph.resolveList().forEach((pkg) => {\\n\\tconsole.log(pkg.name);\\n});\\n```"}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":68,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L68"}],"type":{"type":"array","elementType":{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}}}]},{"id":2779,"name":"resolveTree","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L90"}],"signatures":[{"id":2780,"name":"resolveTree","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolve the dependency graph and return a tree of nodes for all\\n"},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" objects and their dependency mappings.\\n\\n"},{"kind":"code","text":"```ts\\ngraph.resolveTree().nodes.forEach((node) => {\\n\\tconsole.log(node.package.name);\\n\\n\\tif (node.nodes) {\\n\\t\\t// Dependents\\n\\t}\\n});\\n```"}]},"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L90"}],"type":{"type":"reference","target":3041,"typeArguments":[{"type":"reference","target":2766,"name":"T","package":"@boost/common","qualifiedName":"PackageGraph.T","refersToTypeParameter":true}],"name":"PackageGraphTree","package":"@boost/common"}}]}],"groups":[{"title":"Constructors","children":[2764]},{"title":"Methods","children":[2771,2774,2781,2777,2779]}],"sources":[{"fileName":"packages/common/src/PackageGraph.ts","line":17,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PackageGraph.ts#L17"}],"typeParameters":[{"id":2801,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"},"default":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"permalink":"/api/common/class/PackageGraph","previousId":2735,"nextId":2802},{"id":2802,"name":"Path","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"An immutable class for operating on file system paths.\\nWill normalize path separators based on the operating system,\\n\\"/\\" on Linux/MacOS, and \\"\\\\\\\\\\" on Windows."}]},"children":[{"id":2815,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L19"}],"signatures":[{"id":2816,"name":"new Path","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L19"}],"parameters":[{"id":2817,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2803,"name":"DELIMITER","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":11,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L11"}],"type":{"type":"union","types":[{"type":"literal","value":";"},{"type":"literal","value":":"}]},"defaultValue":"path.delimiter"},{"id":2804,"name":"SEP","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":13,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L13"}],"type":{"type":"union","types":[{"type":"literal","value":"\\\\"},{"type":"literal","value":"/"}]},"defaultValue":"path.sep"},{"id":2820,"name":"append","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L48"}],"signatures":[{"id":2821,"name":"append","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Append path parts to the end of the current path\\nand return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L48"}],"parameters":[{"id":2822,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2823,"name":"equals","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L55"}],"signatures":[{"id":2824,"name":"equals","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns true if both paths are equal using strict equality."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L55"}],"parameters":[{"id":2825,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2829,"name":"exists","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":71,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L71"}],"signatures":[{"id":2830,"name":"exists","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path exists."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":71,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L71"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2826,"name":"ext","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":62,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L62"}],"signatures":[{"id":2827,"name":"ext","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the extension (if applicable) with or without leading period."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":62,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L62"}],"parameters":[{"id":2828,"name":"withoutPeriod","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2831,"name":"isAbsolute","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L78"}],"signatures":[{"id":2832,"name":"isAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is absolute."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L78"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2833,"name":"isDirectory","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L85"}],"signatures":[{"id":2834,"name":"isDirectory","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is a folder."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L85"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2835,"name":"isFile","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L92"}],"signatures":[{"id":2836,"name":"isFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is a file."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L92"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":2837,"name":"name","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L99"}],"signatures":[{"id":2838,"name":"name","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the file name (with optional extension) or folder name."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L99"}],"parameters":[{"id":2839,"name":"withoutExtension","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2840,"name":"parent","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L112"}],"signatures":[{"id":2841,"name":"parent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the parent folder as a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L112"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2842,"name":"path","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L119"}],"signatures":[{"id":2843,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the current path as a normalized string."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L119"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2914,"name":"Pathable.path"}}],"implementationOf":{"type":"reference","target":2914,"name":"Pathable.path"}},{"id":2844,"name":"prepend","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L132"}],"signatures":[{"id":2845,"name":"prepend","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Prepend path parts to the beginning of the current path\\nand return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L132"}],"parameters":[{"id":2846,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2847,"name":"realPath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L140"}],"signatures":[{"id":2848,"name":"realPath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a canonical path by resolving directories and symlinks."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L140"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2849,"name":"relativeTo","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":148,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L148"}],"signatures":[{"id":2850,"name":"relativeTo","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a new relative "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance from the current\\n\\"from\\" path to the defined \\"to\\" path."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":148,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L148"}],"parameters":[{"id":2851,"name":"to","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2852,"name":"resolve","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L156"}],"signatures":[{"id":2853,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance where the current path is accurately\\nresolved against the defined working directory."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L156"}],"parameters":[{"id":2854,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2855,"name":"toJSON","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L160"}],"signatures":[{"id":2856,"name":"toJSON","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L160"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2857,"name":"toString","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L164"}],"signatures":[{"id":2858,"name":"toString","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L164"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":2917,"name":"Pathable.toString"}}],"implementationOf":{"type":"reference","target":2917,"name":"Pathable.toString"}},{"id":2805,"name":"create","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L26"}],"signatures":[{"id":2806,"name":"create","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L26"}],"parameters":[{"id":2807,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]},{"id":2808,"name":"path","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":33,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L33"}],"signatures":[{"id":2809,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a path-like value to a formatted path string."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":33,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L33"}],"parameters":[{"id":2810,"name":"part","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"string"}}]},{"id":2811,"name":"resolve","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":40,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L40"}],"signatures":[{"id":2812,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`create()`"},{"kind":"text","text":" but also resolves the path against a working directory."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":40,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L40"}],"parameters":[{"id":2813,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}},{"id":2814,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}]}],"groups":[{"title":"Constructors","children":[2815]},{"title":"Properties","children":[2803,2804]},{"title":"Methods","children":[2820,2823,2829,2826,2831,2833,2835,2837,2840,2842,2844,2847,2849,2852,2855,2857,2805,2808,2811]}],"sources":[{"fileName":"packages/common/src/Path.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L10"}],"extendedBy":[{"type":"reference","target":3055,"name":"VirtualPath"}],"implementedTypes":[{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}],"permalink":"/api/common/class/Path","previousId":2763,"nextId":2859},{"id":2859,"name":"PathResolver","variant":"declaration","kind":128,"flags":{},"children":[{"id":2864,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L12"}],"signatures":[{"id":2865,"name":"new PathResolver","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L12"}],"parameters":[{"id":2866,"name":"resolver","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2922,"name":"ModuleResolver","package":"@boost/common"}}],"type":{"type":"reference","target":2859,"name":"PathResolver","package":"@boost/common"}}]},{"id":2869,"name":"getLookupPaths","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L38"}],"signatures":[{"id":2870,"name":"getLookupPaths","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all lookup paths."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L38"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}]},{"id":2871,"name":"lookupFilePath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":46,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L46"}],"signatures":[{"id":2872,"name":"lookupFilePath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a file system path to look for, resolved against the defined current\\nworking directory (or "},{"kind":"code","text":"`process.cwd()`"},{"kind":"text","text":" otherwise)."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":46,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L46"}],"parameters":[{"id":2873,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}},{"id":2874,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2875,"name":"lookupFilePathWithExts","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":60,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L60"}],"signatures":[{"id":2876,"name":"lookupFilePathWithExts","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a file system path with a list of possible extensions to look for,\\nresolved against the defined current working directory (or "},{"kind":"code","text":"`process.cwd()`"},{"kind":"text","text":" otherwise)."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":60,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L60"}],"parameters":[{"id":2877,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}},{"id":2878,"name":"exts","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2879,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2880,"name":"lookupNodeModule","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L73"}],"signatures":[{"id":2881,"name":"lookupNodeModule","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a Node.js module, either by name or relative path, to look for."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L73"}],"parameters":[{"id":2882,"name":"moduleId","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":2883,"name":"resolve","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":88,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L88"}],"signatures":[{"id":2884,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Given a list of lookups, attempt to find the first real/existing path and\\nreturn a resolved absolute path. If a file system path, will check using "},{"kind":"code","text":"`fs.exists`"},{"kind":"text","text":".\\nIf a node module path, will check using the provided resolver."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":88,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L88"}],"parameters":[{"id":2885,"name":"startDir","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2933,"name":"ResolvedLookup","package":"@boost/common"}],"name":"Promise","package":"typescript"}}]},{"id":2886,"name":"resolvePath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":136,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L136"}],"signatures":[{"id":2887,"name":"resolvePath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`resolve()`"},{"kind":"text","text":" but only returns the resolved file path."}]},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":136,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L136"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}],"name":"Promise","package":"typescript"}}]},{"id":2860,"name":"defaultResolver","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":16,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L16"}],"signatures":[{"id":2861,"name":"defaultResolver","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":16,"character":14,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L16"}],"parameters":[{"id":2862,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":2863,"name":"startDir","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[2864]},{"title":"Methods","children":[2869,2871,2875,2880,2883,2886,2860]}],"sources":[{"fileName":"packages/common/src/PathResolver.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/PathResolver.ts#L7"}],"permalink":"/api/common/class/PathResolver","previousId":2802,"nextId":2890},{"id":2890,"name":"Project","variant":"declaration","kind":128,"flags":{},"children":[{"id":2894,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L18"}],"signatures":[{"id":2895,"name":"new Project","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L18"}],"parameters":[{"id":2896,"name":"root","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"},"defaultValue":"..."}],"type":{"type":"reference","target":2890,"name":"Project","package":"@boost/common"}}]},{"id":2897,"name":"root","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/common/src/Project.ts","line":16,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L16"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}},{"id":2898,"name":"createWorkspaceMetadata","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L33"}],"signatures":[{"id":2899,"name":"createWorkspaceMetadata","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create a workspace metadata object composed of absolute file paths."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L33"}],"parameters":[{"id":2900,"name":"jsonPath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":3045,"name":"WorkspaceMetadata","package":"@boost/common"}}]},{"id":2901,"name":"getPackage","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L51"}],"signatures":[{"id":2902,"name":"getPackage","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the contents of the root "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L51"}],"typeParameter":[{"id":2903,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"type":{"type":"reference","target":2903,"name":"T","package":"@boost/common","refersToTypeParameter":true}}]},{"id":2904,"name":"getWorkspaceGlobs","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L67"}],"signatures":[{"id":2905,"name":"getWorkspaceGlobs","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all workspace globs as they are configured\\nin "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" or "},{"kind":"code","text":"`lerna.json`"},{"kind":"text","text":". Glob patterns will _always_\\nuse forward slashes, regardless of OS."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L67"}],"parameters":[{"id":2906,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2888,"name":"ProjectSearchOptions","package":"@boost/common"},"defaultValue":"{}"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}]},{"id":2910,"name":"getWorkspacePackagePaths","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L140"}],"signatures":[{"id":2911,"name":"getWorkspacePackagePaths","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all workspace package paths, resolved against the file system.\\nAbsolute file paths are returned unless the "},{"kind":"code","text":"`relative`"},{"kind":"text","text":" option is true."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L140"}],"parameters":[{"id":2912,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2888,"name":"ProjectSearchOptions","package":"@boost/common"},"defaultValue":"{}"}],"type":{"type":"array","elementType":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}}]},{"id":2907,"name":"getWorkspacePackages","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Project.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L118"}],"signatures":[{"id":2908,"name":"getWorkspacePackages","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return all "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":"s across all workspaces and their packages.\\nOnce loaded, append workspace path metadata."}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L118"}],"typeParameter":[{"id":2909,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"type":{"type":"array","elementType":{"type":"reference","target":3051,"typeArguments":[{"type":"reference","target":2909,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"WorkspacePackage","package":"@boost/common"}}}]},{"id":2891,"name":"normalizeGlob","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Project.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L26"}],"signatures":[{"id":2892,"name":"normalizeGlob","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize a glob pattern or path for use on POSIX and Windows machines."}],"blockTags":[{"tag":"@link","content":[{"kind":"text","text":"https://github.com/mrmlnc/fast-glob#how-to-write-patterns-on-windows"}]}]},"sources":[{"fileName":"packages/common/src/Project.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L26"}],"parameters":[{"id":2893,"name":"pattern","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}]}],"groups":[{"title":"Constructors","children":[2894]},{"title":"Properties","children":[2897]},{"title":"Methods","children":[2898,2901,2904,2910,2907,2891]}],"sources":[{"fileName":"packages/common/src/Project.ts","line":15,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L15"}],"permalink":"/api/common/class/Project","previousId":2859,"nextId":3055},{"id":3055,"name":"VirtualPath","variant":"declaration","kind":128,"flags":{},"comment":{"summary":[{"kind":"text","text":"An immutable class for operating on file system paths,\\nthat always normalize using a forward slash (\\"/\\") for path separators.\\nUseful for paths found in configurations, globs, etc."}]},"children":[{"id":3068,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L19"}],"signatures":[{"id":3069,"name":"new VirtualPath","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L19"}],"parameters":[{"id":3070,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":3055,"name":"VirtualPath","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2816,"name":"Path.constructor"}}],"inheritedFrom":{"type":"reference","target":2815,"name":"Path.constructor"}},{"id":3059,"name":"DELIMITER","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":11,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L11"}],"type":{"type":"union","types":[{"type":"literal","value":";"},{"type":"literal","value":":"}]},"defaultValue":"path.delimiter","inheritedFrom":{"type":"reference","target":2803,"name":"Path.DELIMITER"}},{"id":3060,"name":"SEP","variant":"declaration","kind":1024,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":13,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L13"}],"type":{"type":"union","types":[{"type":"literal","value":"\\\\"},{"type":"literal","value":"/"}]},"defaultValue":"path.sep","inheritedFrom":{"type":"reference","target":2804,"name":"Path.SEP"}},{"id":3075,"name":"append","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L48"}],"signatures":[{"id":3076,"name":"append","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Append path parts to the end of the current path\\nand return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L48"}],"parameters":[{"id":3077,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2821,"name":"Path.append"}}],"inheritedFrom":{"type":"reference","target":2820,"name":"Path.append"}},{"id":3078,"name":"equals","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L55"}],"signatures":[{"id":3079,"name":"equals","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns true if both paths are equal using strict equality."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L55"}],"parameters":[{"id":3080,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2824,"name":"Path.equals"}}],"inheritedFrom":{"type":"reference","target":2823,"name":"Path.equals"}},{"id":3084,"name":"exists","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":71,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L71"}],"signatures":[{"id":3085,"name":"exists","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path exists."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":71,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L71"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2830,"name":"Path.exists"}}],"inheritedFrom":{"type":"reference","target":2829,"name":"Path.exists"}},{"id":3081,"name":"ext","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":62,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L62"}],"signatures":[{"id":3082,"name":"ext","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the extension (if applicable) with or without leading period."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":62,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L62"}],"parameters":[{"id":3083,"name":"withoutPeriod","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2827,"name":"Path.ext"}}],"inheritedFrom":{"type":"reference","target":2826,"name":"Path.ext"}},{"id":3086,"name":"isAbsolute","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L78"}],"signatures":[{"id":3087,"name":"isAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is absolute."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L78"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2832,"name":"Path.isAbsolute"}}],"inheritedFrom":{"type":"reference","target":2831,"name":"Path.isAbsolute"}},{"id":3088,"name":"isDirectory","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L85"}],"signatures":[{"id":3089,"name":"isDirectory","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is a folder."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L85"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2834,"name":"Path.isDirectory"}}],"inheritedFrom":{"type":"reference","target":2833,"name":"Path.isDirectory"}},{"id":3090,"name":"isFile","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L92"}],"signatures":[{"id":3091,"name":"isFile","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the current path is a file."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L92"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":2836,"name":"Path.isFile"}}],"inheritedFrom":{"type":"reference","target":2835,"name":"Path.isFile"}},{"id":3092,"name":"name","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L99"}],"signatures":[{"id":3093,"name":"name","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the file name (with optional extension) or folder name."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L99"}],"parameters":[{"id":3094,"name":"withoutExtension","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2838,"name":"Path.name"}}],"inheritedFrom":{"type":"reference","target":2837,"name":"Path.name"}},{"id":3095,"name":"parent","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L112"}],"signatures":[{"id":3096,"name":"parent","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the parent folder as a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L112"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2841,"name":"Path.parent"}}],"inheritedFrom":{"type":"reference","target":2840,"name":"Path.parent"}},{"id":3071,"name":"path","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":22,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L22"}],"signatures":[{"id":3072,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return the current module path as a normalized string,\\nconverting all path separators to \\"/\\"."}]},"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":22,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L22"}],"type":{"type":"intrinsic","name":"string"},"overwrites":{"type":"reference","target":2843,"name":"Path.path"}}],"overwrites":{"type":"reference","target":2842,"name":"Path.path"}},{"id":3097,"name":"prepend","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L132"}],"signatures":[{"id":3098,"name":"prepend","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Prepend path parts to the beginning of the current path\\nand return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L132"}],"parameters":[{"id":3099,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2845,"name":"Path.prepend"}}],"inheritedFrom":{"type":"reference","target":2844,"name":"Path.prepend"}},{"id":3100,"name":"realPath","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L140"}],"signatures":[{"id":3101,"name":"realPath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a canonical path by resolving directories and symlinks."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L140"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2848,"name":"Path.realPath"}}],"inheritedFrom":{"type":"reference","target":2847,"name":"Path.realPath"}},{"id":3102,"name":"relativeTo","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":148,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L148"}],"signatures":[{"id":3103,"name":"relativeTo","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a new relative "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance from the current\\n\\"from\\" path to the defined \\"to\\" path."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":148,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L148"}],"parameters":[{"id":3104,"name":"to","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2850,"name":"Path.relativeTo"}}],"inheritedFrom":{"type":"reference","target":2849,"name":"Path.relativeTo"}},{"id":3105,"name":"resolve","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L156"}],"signatures":[{"id":3106,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance where the current path is accurately\\nresolved against the defined working directory."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L156"}],"parameters":[{"id":3107,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2853,"name":"Path.resolve"}}],"inheritedFrom":{"type":"reference","target":2852,"name":"Path.resolve"}},{"id":3108,"name":"toJSON","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L160"}],"signatures":[{"id":3109,"name":"toJSON","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L160"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2856,"name":"Path.toJSON"}}],"inheritedFrom":{"type":"reference","target":2855,"name":"Path.toJSON"}},{"id":3110,"name":"toString","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L164"}],"signatures":[{"id":3111,"name":"toString","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/Path.ts","line":164,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L164"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2858,"name":"Path.toString"}}],"inheritedFrom":{"type":"reference","target":2857,"name":"Path.toString"}},{"id":3061,"name":"create","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L26"}],"signatures":[{"id":3062,"name":"create","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a new "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":26,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L26"}],"parameters":[{"id":3063,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2806,"name":"Path.create"}}],"inheritedFrom":{"type":"reference","target":2805,"name":"Path.create"}},{"id":3056,"name":"path","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":14,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L14"}],"signatures":[{"id":3057,"name":"path","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Convert a path-like value to a formatted virtual path string."}]},"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":14,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L14"}],"parameters":[{"id":3058,"name":"part","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"string"},"overwrites":{"type":"reference","target":2809,"name":"Path.path"}}],"overwrites":{"type":"reference","target":2808,"name":"Path.path"}},{"id":3064,"name":"resolve","variant":"declaration","kind":2048,"flags":{"isStatic":true},"sources":[{"fileName":"packages/common/src/Path.ts","line":40,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L40"}],"signatures":[{"id":3065,"name":"resolve","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`create()`"},{"kind":"text","text":" but also resolves the path against a working directory."}]},"sources":[{"fileName":"packages/common/src/Path.ts","line":40,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Path.ts#L40"}],"parameters":[{"id":3066,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}},{"id":3067,"name":"cwd","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":2812,"name":"Path.resolve"}}],"inheritedFrom":{"type":"reference","target":2811,"name":"Path.resolve"}}],"groups":[{"title":"Constructors","children":[3068]},{"title":"Properties","children":[3059,3060]},{"title":"Methods","children":[3075,3078,3084,3081,3086,3088,3090,3092,3095,3071,3097,3100,3102,3105,3108,3110,3061,3056,3064]}],"sources":[{"fileName":"packages/common/src/VirtualPath.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/VirtualPath.ts#L10"}],"extendedTypes":[{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}],"permalink":"/api/common/class/VirtualPath","previousId":2890,"nextId":3112},{"id":2965,"name":"BugSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2967,"name":"email","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":78,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L78"}],"type":{"type":"intrinsic","name":"string"}},{"id":2966,"name":"url","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":77,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L77"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2967,2966]}],"sources":[{"fileName":"packages/common/src/types.ts","line":76,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L76"}],"permalink":"/api/common/interface/BugSetting","previousId":2731,"nextId":2969},{"id":2969,"name":"DependencyMetaSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2970,"name":"built","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L84"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2971,"name":"optional","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":85,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L85"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":2972,"name":"unplugged","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":86,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L86"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2970,2971,2972]}],"sources":[{"fileName":"packages/common/src/types.ts","line":83,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L83"}],"permalink":"/api/common/interface/DependencyMetaSetting","previousId":2965,"nextId":2929},{"id":2929,"name":"Lookup","variant":"declaration","kind":256,"flags":{},"children":[{"id":2930,"name":"path","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L26"}],"type":{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}},{"id":2931,"name":"raw","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L27"}],"type":{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}},{"id":2932,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L28"}],"type":{"type":"reference","target":2928,"name":"LookupType","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[2930,2931,2932]}],"sources":[{"fileName":"packages/common/src/types.ts","line":25,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L25"}],"permalink":"/api/common/interface/Lookup","previousId":2969,"nextId":3143},{"id":3143,"name":"MemoizeOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3144,"name":"cache","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A custom "},{"kind":"code","text":"`Map`"},{"kind":"text","text":" instance to store cached values. Can also be used to pre-cache expected values."}]},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":9,"character":4}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":3138,"typeArguments":[{"type":"reference","target":3147,"name":"T","package":"@boost/decorators","qualifiedName":"MemoizeOptions.T","refersToTypeParameter":true}],"name":"MemoizeCache","package":"@boost/decorators"}]}},{"id":3145,"name":"expires","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Time in milliseconds in which to keep the cache alive (TTL).\\nPass "},{"kind":"code","text":"`0`"},{"kind":"text","text":" to cache indefinitely. Defaults to "},{"kind":"code","text":"`0`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":14,"character":4}],"type":{"type":"intrinsic","name":"number"}},{"id":3146,"name":"hasher","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A hashing function to determine the cache key. Is passed the method\'s arguments\\nand must return a string. If not provided, arguments are hashed using "},{"kind":"code","text":"`JSON.stringify()`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":19,"character":4}],"type":{"type":"reference","target":3134,"name":"MemoizeHasher","package":"@boost/decorators"}}],"groups":[{"title":"Properties","children":[3144,3145,3146]}],"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":7,"character":17}],"typeParameters":[{"id":3147,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/common/interface/MemoizeOptions","previousId":2929,"nextId":2955},{"id":2955,"name":"Optionable","variant":"declaration","kind":256,"flags":{},"children":[{"id":2957,"name":"blueprint","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":63,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L63"}],"type":{"type":"reference","target":2949,"typeArguments":[{"type":"intrinsic","name":"object"}],"name":"BlueprintFactory","package":"@boost/common"}},{"id":2956,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":57,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L57"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":2958,"name":"T","package":"@boost/common","qualifiedName":"Optionable.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"}}],"groups":[{"title":"Properties","children":[2957,2956]}],"sources":[{"fileName":"packages/common/src/types.ts","line":55,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L55"}],"typeParameters":[{"id":2958,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":2959,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":55,"character":47,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L55"}]}}}],"implementedBy":[{"type":"reference","target":2659,"name":"Contract"}],"permalink":"/api/common/interface/Optionable","previousId":3143,"nextId":3041},{"id":3041,"name":"PackageGraphTree","variant":"declaration","kind":256,"flags":{},"children":[{"id":3042,"name":"nodes","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":176,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L176"}],"type":{"type":"array","elementType":{"type":"reference","target":3037,"typeArguments":[{"type":"reference","target":3044,"name":"T","package":"@boost/common","qualifiedName":"PackageGraphTree.T","refersToTypeParameter":true}],"name":"PackageGraphTreeNode","package":"@boost/common"}}},{"id":3043,"name":"root","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":177,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L177"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[3042,3043]}],"sources":[{"fileName":"packages/common/src/types.ts","line":175,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L175"}],"typeParameters":[{"id":3044,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"permalink":"/api/common/interface/PackageGraphTree","previousId":2955,"nextId":3037},{"id":3037,"name":"PackageGraphTreeNode","variant":"declaration","kind":256,"flags":{},"children":[{"id":3038,"name":"nodes","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":171,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L171"}],"type":{"type":"array","elementType":{"type":"reference","target":3037,"typeArguments":[{"type":"reference","target":3040,"name":"T","package":"@boost/common","qualifiedName":"PackageGraphTreeNode.T","refersToTypeParameter":true}],"name":"PackageGraphTreeNode","package":"@boost/common"}}},{"id":3039,"name":"package","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":172,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L172"}],"type":{"type":"reference","target":3040,"name":"T","package":"@boost/common","qualifiedName":"PackageGraphTreeNode.T","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[3038,3039]}],"sources":[{"fileName":"packages/common/src/types.ts","line":170,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L170"}],"typeParameters":[{"id":3040,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"permalink":"/api/common/interface/PackageGraphTreeNode","previousId":3041,"nextId":2986},{"id":2986,"name":"PackageStructure","variant":"declaration","kind":256,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shape of "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":", with support for third-party properties\\nlike Yarn, Webpack, and TypeScript."}]},"children":[{"id":2987,"name":"author","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":113,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L113"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2978,"name":"PeopleSetting","package":"@boost/common"}]}},{"id":2988,"name":"bin","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":114,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L114"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}]}},{"id":2989,"name":"browser","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":115,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L115"}],"type":{"type":"intrinsic","name":"string"}},{"id":2990,"name":"browserslist","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":116,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L116"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2991,"name":"bugs","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":117,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L117"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2965,"name":"BugSetting","package":"@boost/common"}]}},{"id":2992,"name":"bundledDependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L118"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2993,"name":"config","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L119"}],"type":{"type":"reference","target":2964,"name":"ConfigSetting","package":"@boost/common"}},{"id":2994,"name":"contributors","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":120,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L120"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"array","elementType":{"type":"reference","target":2978,"name":"PeopleSetting","package":"@boost/common"}}]}},{"id":2995,"name":"cpu","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":121,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L121"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":2996,"name":"dependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":122,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L122"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":2997,"name":"dependenciesMeta","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L123"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2969,"name":"DependencyMetaSetting","package":"@boost/common"}],"name":"Record","package":"typescript"}},{"id":2998,"name":"description","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":124,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L124"}],"type":{"type":"intrinsic","name":"string"}},{"id":2999,"name":"devDependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L125"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":3000,"name":"directories","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L126"}],"type":{"type":"reference","target":2962,"typeArguments":[{"type":"union","types":[{"type":"literal","value":"test"},{"type":"literal","value":"bin"},{"type":"literal","value":"doc"},{"type":"literal","value":"example"},{"type":"literal","value":"lib"},{"type":"literal","value":"man"}]}],"name":"SettingMap","package":"@boost/common"}},{"id":3001,"name":"engines","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":127,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L127"}],"type":{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}},{"id":3002,"name":"exports","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":128,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L128"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}]}],"name":"Record","package":"typescript"}]}},{"id":3003,"name":"files","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":129,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L129"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":3004,"name":"funding","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":130,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L130"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"},{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"}]}}]}},{"id":3005,"name":"homepage","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":131,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L131"}],"type":{"type":"intrinsic","name":"string"}},{"id":3006,"name":"imports","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":132,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L132"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}],"name":"Record","package":"typescript"}},{"id":3027,"name":"installConfig","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":156,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L156"}],"type":{"type":"reflection","declaration":{"id":3028,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3029,"name":"hoistingLimits","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":157,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L157"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[3029]}],"sources":[{"fileName":"packages/common/src/types.ts","line":156,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L156"}]}}},{"id":3007,"name":"keywords","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":133,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L133"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":3030,"name":"languageName","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":159,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L159"}],"type":{"type":"intrinsic","name":"string"}},{"id":3008,"name":"license","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":134,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L134"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"},{"type":"array","elementType":{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"}}]}},{"id":3009,"name":"main","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":135,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L135"}],"type":{"type":"intrinsic","name":"string"}},{"id":3010,"name":"man","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":136,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L136"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":3025,"name":"module","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L153"}],"type":{"type":"intrinsic","name":"string"}},{"id":3011,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":137,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L137"}],"type":{"type":"intrinsic","name":"string"}},{"id":3012,"name":"optionalDependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":138,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L138"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":3013,"name":"os","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":139,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L139"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":3014,"name":"peerDependencies","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L140"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":3015,"name":"peerDependenciesMeta","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":141,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L141"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2976,"name":"PeerDependencyMetaSetting","package":"@boost/common"}],"name":"Record","package":"typescript"}},{"id":3031,"name":"preferUnplugged","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":160,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L160"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":3016,"name":"private","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":142,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L142"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":3017,"name":"publishConfig","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":143,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L143"}],"type":{"type":"reference","target":2964,"name":"ConfigSetting","package":"@boost/common"}},{"id":3018,"name":"repository","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":144,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L144"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":2982,"name":"RepositorySetting","package":"@boost/common"}]}},{"id":3032,"name":"resolutions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":161,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L161"}],"type":{"type":"reference","target":2968,"name":"DependencyMap","package":"@boost/common"}},{"id":3019,"name":"scripts","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":145,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L145"}],"type":{"type":"reference","target":2962,"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"SettingMap","package":"@boost/common"}},{"id":3026,"name":"sideEffects","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":154,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L154"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":3020,"name":"type","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":146,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L146"}],"type":{"type":"union","types":[{"type":"literal","value":"commonjs"},{"type":"literal","value":"module"}]}},{"id":3022,"name":"types","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":149,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L149"}],"type":{"type":"intrinsic","name":"string"}},{"id":3023,"name":"typesVersions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":150,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L150"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}],"name":"Record","package":"typescript"}],"name":"Record","package":"typescript"}},{"id":3024,"name":"typings","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":151,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L151"}],"type":{"type":"intrinsic","name":"string"}},{"id":3021,"name":"version","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":147,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L147"}],"type":{"type":"intrinsic","name":"string"}},{"id":3033,"name":"workspaces","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":162,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L162"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"reflection","declaration":{"id":3034,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3036,"name":"nohoist","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":166,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L166"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":3035,"name":"packages","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":165,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L165"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"groups":[{"title":"Properties","children":[3036,3035]}],"sources":[{"fileName":"packages/common/src/types.ts","line":164,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L164"}]}}]}}],"groups":[{"title":"Properties","children":[2987,2988,2989,2990,2991,2992,2993,2994,2995,2996,2997,2998,2999,3000,3001,3002,3003,3004,3005,3006,3027,3007,3030,3008,3009,3010,3025,3011,3012,3013,3014,3015,3031,3016,3017,3018,3032,3019,3026,3020,3022,3023,3024,3021,3033]}],"sources":[{"fileName":"packages/common/src/types.ts","line":112,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L112"}],"permalink":"/api/common/interface/PackageStructure","previousId":3037,"nextId":2913},{"id":2913,"name":"Pathable","variant":"declaration","kind":256,"flags":{},"children":[{"id":2914,"name":"path","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L7"}],"type":{"type":"reflection","declaration":{"id":2915,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":7,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L7"}],"signatures":[{"id":2916,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":7,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L7"}],"type":{"type":"intrinsic","name":"string"}}]}}},{"id":2917,"name":"toString","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L8"}],"type":{"type":"reflection","declaration":{"id":2918,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":8,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L8"}],"signatures":[{"id":2919,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":8,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L8"}],"type":{"type":"intrinsic","name":"string"}}]}}}],"groups":[{"title":"Properties","children":[2914,2917]}],"sources":[{"fileName":"packages/common/src/types.ts","line":6,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L6"}],"implementedBy":[{"type":"reference","target":2735,"name":"ModulePath"},{"type":"reference","target":2802,"name":"Path"}],"permalink":"/api/common/interface/Pathable","previousId":2986,"nextId":2976},{"id":2976,"name":"PeerDependencyMetaSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2977,"name":"optional","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2977]}],"sources":[{"fileName":"packages/common/src/types.ts","line":94,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L94"}],"permalink":"/api/common/interface/PeerDependencyMetaSetting","previousId":2913,"nextId":2978},{"id":2978,"name":"PeopleSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2980,"name":"email","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":100,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L100"}],"type":{"type":"intrinsic","name":"string"}},{"id":2979,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L99"}],"type":{"type":"intrinsic","name":"string"}},{"id":2981,"name":"url","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":101,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L101"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2980,2979,2981]}],"sources":[{"fileName":"packages/common/src/types.ts","line":98,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L98"}],"permalink":"/api/common/interface/PeopleSetting","previousId":2976,"nextId":2888},{"id":2888,"name":"ProjectSearchOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":2889,"name":"relative","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/Project.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L12"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[2889]}],"sources":[{"fileName":"packages/common/src/Project.ts","line":11,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/Project.ts#L11"}],"permalink":"/api/common/interface/ProjectSearchOptions","previousId":2978,"nextId":2982},{"id":2982,"name":"RepositorySetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2983,"name":"directory","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/common/src/types.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L105"}],"type":{"type":"intrinsic","name":"string"}},{"id":2984,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L90"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2974,"name":"TypeSetting.type"}},{"id":2985,"name":"url","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L91"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":2975,"name":"TypeSetting.url"}}],"groups":[{"title":"Properties","children":[2983,2984,2985]}],"sources":[{"fileName":"packages/common/src/types.ts","line":104,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L104"}],"extendedTypes":[{"type":"reference","target":2973,"name":"TypeSetting","package":"@boost/common"}],"permalink":"/api/common/interface/RepositorySetting","previousId":2888,"nextId":2933},{"id":2933,"name":"ResolvedLookup","variant":"declaration","kind":256,"flags":{},"children":[{"id":2934,"name":"originalSource","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Original file path or module ID of the lookup."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L33"}],"type":{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}},{"id":2935,"name":"resolvedPath","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Resolved absolute *file* path for the found lookup."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L35"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}},{"id":2936,"name":"type","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The type of lookup that was found."}]},"sources":[{"fileName":"packages/common/src/types.ts","line":37,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L37"}],"type":{"type":"reference","target":2928,"name":"LookupType","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[2934,2935,2936]}],"sources":[{"fileName":"packages/common/src/types.ts","line":31,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L31"}],"permalink":"/api/common/interface/ResolvedLookup","previousId":2982,"nextId":2960},{"id":2960,"name":"Toolable","variant":"declaration","kind":256,"flags":{},"children":[{"id":2961,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L67"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2961]}],"sources":[{"fileName":"packages/common/src/types.ts","line":66,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L66"}],"permalink":"/api/common/interface/Toolable","previousId":2933,"nextId":2973},{"id":2973,"name":"TypeSetting","variant":"declaration","kind":256,"flags":{},"children":[{"id":2974,"name":"type","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L90"}],"type":{"type":"intrinsic","name":"string"}},{"id":2975,"name":"url","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L91"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[2974,2975]}],"sources":[{"fileName":"packages/common/src/types.ts","line":89,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L89"}],"extendedBy":[{"type":"reference","target":2982,"name":"RepositorySetting"}],"permalink":"/api/common/interface/TypeSetting","previousId":2960,"nextId":3045},{"id":3045,"name":"WorkspaceMetadata","variant":"declaration","kind":256,"flags":{},"children":[{"id":3046,"name":"jsonPath","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":183,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L183"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}},{"id":3048,"name":"packageName","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":185,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L185"}],"type":{"type":"intrinsic","name":"string"}},{"id":3047,"name":"packagePath","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":184,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L184"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}},{"id":3050,"name":"workspaceName","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":187,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L187"}],"type":{"type":"intrinsic","name":"string"}},{"id":3049,"name":"workspacePath","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":186,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L186"}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[3046,3048,3047,3050,3049]}],"sources":[{"fileName":"packages/common/src/types.ts","line":182,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L182"}],"permalink":"/api/common/interface/WorkspaceMetadata","previousId":2973,"nextId":3051},{"id":3051,"name":"WorkspacePackage","variant":"declaration","kind":256,"flags":{},"children":[{"id":3052,"name":"metadata","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":191,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L191"}],"type":{"type":"reference","target":3045,"name":"WorkspaceMetadata","package":"@boost/common"}},{"id":3053,"name":"package","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":192,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L192"}],"type":{"type":"reference","target":3054,"name":"T","package":"@boost/common","qualifiedName":"WorkspacePackage.T","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[3052,3053]}],"sources":[{"fileName":"packages/common/src/types.ts","line":190,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L190"}],"typeParameters":[{"id":3054,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"},"default":{"type":"reference","target":2986,"name":"PackageStructure","package":"@boost/common"}}],"permalink":"/api/common/interface/WorkspacePackage","previousId":3045,"nextId":2610},{"id":2937,"name":"AbstractConstructor","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":42,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L42"}],"typeParameters":[{"id":2941,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":2938,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":42,"character":37,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L42"}],"signatures":[{"id":2939,"name":"__type","variant":"signature","kind":16384,"flags":{"isAbstract":true},"parameters":[{"id":2940,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","target":2941,"name":"T","package":"@boost/common","refersToTypeParameter":true}}]}},"permalink":"/api/common#AbstractConstructor","previousId":2637,"nextId":2949},{"id":2949,"name":"BlueprintFactory","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":50,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L50"}],"typeParameters":[{"id":2954,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"type":{"type":"reflection","declaration":{"id":2950,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":50,"character":49,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L50"}],"signatures":[{"id":2951,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2952,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/index.d.ts","qualifiedName":"Schemas"},"name":"Schemas","package":"optimal"}},{"id":2953,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":2954,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"Blueprint","package":"optimal"}}]}},"permalink":"/api/common#BlueprintFactory","previousId":2937,"nextId":2651},{"id":2651,"name":"CommonErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/CommonError.ts","line":10,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/CommonError.ts#L10"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/common/src/CommonError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/common","preferValues":true}}},"permalink":"/api/common#CommonErrorCode","previousId":2949,"nextId":2942},{"id":2942,"name":"ConcreteConstructor","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":44,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L44"}],"typeParameters":[{"id":2946,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":2943,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":44,"character":37,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L44"}],"signatures":[{"id":2944,"name":"__type","variant":"signature","kind":16384,"flags":{},"parameters":[{"id":2945,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"reference","target":2946,"name":"T","package":"@boost/common","refersToTypeParameter":true}}]}},"permalink":"/api/common#ConcreteConstructor","previousId":2651,"nextId":2964},{"id":2964,"name":"ConfigSetting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":74,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L74"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"string"},{"type":"literal","value":null}]}],"name":"Record","package":"typescript"},"permalink":"/api/common#ConfigSetting","previousId":2942,"nextId":2947},{"id":2947,"name":"Constructor","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":46,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L46"}],"typeParameters":[{"id":2948,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"union","types":[{"type":"reference","target":2937,"typeArguments":[{"type":"reference","target":2948,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"AbstractConstructor","package":"@boost/common"},{"type":"reference","target":2942,"typeArguments":[{"type":"reference","target":2948,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"ConcreteConstructor","package":"@boost/common"}]},"permalink":"/api/common#Constructor","previousId":2964,"nextId":2968},{"id":2968,"name":"DependencyMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":81,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L81"}],"type":{"type":"reference","target":2962,"name":"SettingMap","package":"@boost/common"},"permalink":"/api/common#DependencyMap","previousId":2947,"nextId":2927},{"id":2927,"name":"FilePath","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":21,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L21"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/common#FilePath","previousId":2968,"nextId":2701},{"id":2701,"name":"InferMergeable","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":6,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L6"}],"typeParameters":[{"id":2702,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":2702,"name":"T","package":"@boost/common","refersToTypeParameter":true},"extendsType":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},"trueType":{"type":"reference","target":2698,"name":"MergableArray","package":"@boost/common"},"falseType":{"type":"conditional","checkType":{"type":"reference","target":2702,"name":"T","package":"@boost/common","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"object"},"trueType":{"type":"reference","target":2699,"name":"MergableObject","package":"@boost/common"},"falseType":{"type":"intrinsic","name":"never"}}},"permalink":"/api/common#InferMergeable","previousId":2927,"nextId":2928},{"id":2928,"name":"LookupType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":23,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L23"}],"type":{"type":"union","types":[{"type":"literal","value":"file-system"},{"type":"literal","value":"node-module"}]},"permalink":"/api/common#LookupType","previousId":2701,"nextId":3138},{"id":3138,"name":"MemoizeCache","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":3,"character":12}],"typeParameters":[{"id":3142,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reflection","declaration":{"id":3139,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3140,"name":"time","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":4,"character":4}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"literal","value":null}]}},{"id":3141,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":5,"character":4}],"type":{"type":"reference","target":3142,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[3140,3141]}],"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":3,"character":42}]}}],"name":"Map","package":"typescript"},"permalink":"/api/common#MemoizeCache","previousId":2928,"nextId":3134},{"id":3134,"name":"MemoizeHasher","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":2,"character":12}],"type":{"type":"reflection","declaration":{"id":3135,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":2,"character":28}],"signatures":[{"id":3136,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":3137,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"string"}}]}},"permalink":"/api/common#MemoizeHasher","previousId":3138,"nextId":3129},{"id":3129,"name":"MemoizedFunction","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":1,"character":12}],"typeParameters":[{"id":3133,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":3130,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":1,"character":34}],"signatures":[{"id":3131,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":3132,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"reference","target":3133,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}}]}},"permalink":"/api/common#MemoizedFunction","previousId":3134,"nextId":2698},{"id":2698,"name":"MergableArray","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L3"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},"permalink":"/api/common#MergableArray","previousId":3129,"nextId":2699},{"id":2699,"name":"MergableObject","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":4,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L4"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript"},"permalink":"/api/common#MergableObject","previousId":2698,"nextId":2700},{"id":2700,"name":"Mergeable","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L5"}],"type":{"type":"union","types":[{"type":"reference","target":2698,"name":"MergableArray","package":"@boost/common"},{"type":"reference","target":2699,"name":"MergableObject","package":"@boost/common"}]},"permalink":"/api/common#Mergeable","previousId":2699,"nextId":2921},{"id":2921,"name":"ModuleID","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/common#ModuleID","previousId":2700,"nextId":2922},{"id":2922,"name":"ModuleResolver","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":17,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L17"}],"type":{"type":"reflection","declaration":{"id":2923,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":17,"character":29,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L17"}],"signatures":[{"id":2924,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":2925,"name":"id","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2921,"name":"ModuleID","package":"@boost/common"}},{"id":2926,"name":"startDir","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2927,"name":"FilePath","package":"@boost/common"}}],"type":{"type":"union","types":[{"type":"reference","target":2927,"name":"FilePath","package":"@boost/common"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":2927,"name":"FilePath","package":"@boost/common"}],"name":"Promise","package":"typescript"}]}}]}},"permalink":"/api/common#ModuleResolver","previousId":2921,"nextId":2920},{"id":2920,"name":"PortablePath","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L11"}],"type":{"type":"union","types":[{"type":"reference","target":2927,"name":"FilePath","package":"@boost/common"},{"type":"reference","target":2921,"name":"ModuleID","package":"@boost/common"},{"type":"reference","target":2913,"name":"Pathable","package":"@boost/common"}]},"permalink":"/api/common#PortablePath","previousId":2922,"nextId":2962},{"id":2962,"name":"SettingMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/common/src/types.ts","line":72,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/types.ts#L72"}],"typeParameters":[{"id":2963,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"reference","target":2963,"name":"T","package":"@boost/common","refersToTypeParameter":true},{"type":"intrinsic","name":"string"}],"name":"Record","package":"typescript"},"permalink":"/api/common#SettingMap","previousId":2920,"nextId":2652},{"id":2652,"name":"CommonError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/common/src/CommonError.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/CommonError.ts#L12"}],"type":{"type":"reflection","declaration":{"id":2653,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":2654,"name":"new CommonError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":2655,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"PARSE_INVALID_EXT"},{"type":"literal","value":"PATH_REQUIRE_ABSOLUTE"},{"type":"literal","value":"PATH_RESOLVE_LOOKUPS"},{"type":"literal","value":"PROJECT_NO_PACKAGE"}]}},{"id":2656,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"PARSE_INVALID_EXT"},{"type":"literal","value":"PATH_REQUIRE_ABSOLUTE"},{"type":"literal","value":"PATH_RESOLVE_LOOKUPS"},{"type":"literal","value":"PROJECT_NO_PACKAGE"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/common#CommonError","previousId":2962,"nextId":2657},{"id":2657,"name":"MODULE_NAME_PART","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/common/src/constants.ts","line":2,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/constants.ts#L2"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/common#MODULE_NAME_PART","previousId":2652,"nextId":2658},{"id":2658,"name":"MODULE_NAME_PATTERN","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/common/src/constants.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/constants.ts#L4"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/common#MODULE_NAME_PATTERN","previousId":2657},{"id":3112,"name":"Bind","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Bind.d.ts","line":5,"character":24}],"signatures":[{"id":3113,"name":"Bind","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that automatically binds a class method\'s\\n"},{"kind":"code","text":"`this`"},{"kind":"text","text":" context to its current instance."}]},"sources":[{"fileName":"packages/decorators/mjs/Bind.d.ts","line":5,"character":24}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/common/function/Bind","previousId":3055,"nextId":3114},{"id":3114,"name":"Debounce","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Debounce.d.ts","line":5,"character":24}],"signatures":[{"id":3115,"name":"Debounce","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that delays the execution of the class method\\nby the provided time in milliseconds."}]},"sources":[{"fileName":"packages/decorators/mjs/Debounce.d.ts","line":5,"character":24}],"parameters":[{"id":3116,"name":"delay","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/common/function/Debounce","previousId":3112,"nextId":3117},{"id":3117,"name":"Deprecate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Deprecate.d.ts","line":6,"character":24}],"signatures":[{"id":3118,"name":"Deprecate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A decorator that marks a class declaration, class method,\\nclass property, or method parameter as deprecated by\\nlogging a deprecation message to the console."}]},"sources":[{"fileName":"packages/decorators/mjs/Deprecate.d.ts","line":6,"character":24}],"parameters":[{"id":3119,"name":"message","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reflection","declaration":{"id":3120,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Deprecate.d.ts","line":6,"character":53}],"signatures":[{"id":3121,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":3122,"name":"target","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Function"},"name":"Function","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Object"},"name":"Object","package":"typescript"}]}},{"id":3123,"name":"property","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"symbol"}]}},{"id":3124,"name":"descriptor","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"permalink":"/api/common/function/Deprecate","previousId":3114,"nextId":3125},{"id":3125,"name":"Memoize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":25,"character":24}],"signatures":[{"id":3126,"name":"Memoize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that caches the return value of a class method or\\ngetter to consistently and efficiently return the same value."}]},"sources":[{"fileName":"packages/decorators/mjs/Memoize.d.ts","line":25,"character":24}],"typeParameter":[{"id":3127,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":3128,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":3134,"name":"MemoizeHasher","package":"@boost/decorators"},{"type":"reference","target":3143,"typeArguments":[{"type":"reference","target":3127,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}],"name":"MemoizeOptions","package":"@boost/decorators"}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/common/function/Memoize","previousId":3117,"nextId":3148},{"id":3148,"name":"Throttle","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/mjs/Throttle.d.ts","line":5,"character":24}],"signatures":[{"id":3149,"name":"Throttle","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that throttles the execution of a class method to\\nonly fire once within every delay timeframe (in milliseconds)."}]},"sources":[{"fileName":"packages/decorators/mjs/Throttle.d.ts","line":5,"character":24}],"parameters":[{"id":3150,"name":"delay","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/common/function/Throttle","previousId":3125,"nextId":2684},{"id":2684,"name":"createBlueprint","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/createBlueprint.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/createBlueprint.ts#L21"}],"signatures":[{"id":2685,"name":"createBlueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to generate a blueprint object for use within\\n[optimal](https://github.com/milesj/optimal) checks. All supported optimal\\nschemas are passed as an object to the factory.\\n\\n"},{"kind":"code","text":"```ts\\nimport { createBlueprint } from \'@boost/common\';\\nimport { optimal } from \'@boost/common/optimal\';\\n\\nconst blueprint = createBlueprint(({ string, number }) => ({\\n\\tname: string().required(),\\n\\tage: number().gt(0),\\n}));\\n\\nconst object = optimal(blueprint).validate({});\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/createBlueprint.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/createBlueprint.ts#L21"}],"typeParameter":[{"id":2686,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2687,"name":"factory","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2949,"typeArguments":[{"type":"reference","target":2686,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"BlueprintFactory","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":2686,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"Blueprint","package":"optimal"}}],"permalink":"/api/common/function/createBlueprint","previousId":3148,"nextId":2688},{"id":2688,"name":"deepFreeze","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepFreeze.ts","line":15,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepFreeze.ts#L15"}],"signatures":[{"id":2689,"name":"deepFreeze","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to recursively freeze plain objects with "},{"kind":"code","text":"`Object.freeze`"},{"kind":"text","text":".\\n\\n"},{"kind":"code","text":"```ts\\nimport { deepFreeze } from \'@boost/common\';\\n\\nconst obj = deepFreeze({ foo: 123 });\\n\\n// Errors!\\nobj.foo = 456;\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/deepFreeze.ts","line":15,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepFreeze.ts#L15"}],"typeParameter":[{"id":2690,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2691,"name":"obj","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2690,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"type":{"type":"reference","target":2690,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/function/deepFreeze","previousId":2684,"nextId":2692},{"id":2692,"name":"deepMerge","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":44,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L44"}],"signatures":[{"id":2693,"name":"deepMerge","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to recursively merge objects and arrays, where values on the\\nright-hand side will overwrite values on the left-hand based on the key\\nor index respectively. Furthermore, if the 2nd argument is not provided,\\nit will simply clone the base value.\\n\\n"},{"kind":"code","text":"```ts\\nimport { deepMerge } from \'@boost/common\';\\n\\nconst obj = deepMerge({ foo: 123, bar: \'abc\' }, { foo: 456, baz: true });\\n\\n// -> { foo: 456, bar: \'abc\', baz: true }\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/deepMerge.ts","line":44,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/deepMerge.ts#L44"}],"typeParameter":[{"id":2694,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2700,"name":"Mergeable","package":"@boost/common"}},{"id":2695,"name":"V","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":2700,"name":"Mergeable","package":"@boost/common"}}],"parameters":[{"id":2696,"name":"base","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2694,"name":"T","package":"@boost/common","refersToTypeParameter":true}},{"id":2697,"name":"other","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":2695,"name":"V","package":"@boost/common","refersToTypeParameter":true}}],"type":{"type":"reference","target":2694,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common/function/deepMerge","previousId":2688,"nextId":2703},{"id":2703,"name":"formatMs","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/formatMs.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/formatMs.ts#L14"}],"signatures":[{"id":2704,"name":"formatMs","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to format a UNIX timestamp in milliseconds into a shorthand human readable format.\\nWraps the [pretty-ms](https://www.npmjs.com/package/pretty-ms) package to handle infinite\\nnumbers, zeros, and more.\\n\\n"},{"kind":"code","text":"```ts\\nimport { formatMs } from \'@boost/common\';\\n\\nformatMs(1337000000); // 15d 11h 23m 20s\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/formatMs.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/formatMs.ts#L14"}],"parameters":[{"id":2705,"name":"ms","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":2706,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/pretty-ms/index.d.ts","qualifiedName":"Options"},"name":"Options","package":"pretty-ms"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/common/function/formatMs","previousId":2692,"nextId":2707},{"id":2707,"name":"instanceOf","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/instanceOf.ts","line":32,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/instanceOf.ts#L32"}],"signatures":[{"id":2708,"name":"instanceOf","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Performs a loose instance check by comparing class names up the prototype\\nchain if "},{"kind":"code","text":"`instanceof`"},{"kind":"text","text":" initially fails. To disable this loose check,\\npass "},{"kind":"code","text":"`false`"},{"kind":"text","text":" as the 3rd argument.\\n\\n"},{"kind":"code","text":"```ts\\nimport { instanceOf } from \'@boost/common\';\\n\\nif (instanceOf(error, Error)) {\\n\\tconsole.log(error.stack);\\n}\\n```"},{"kind":"text","text":"\\n\\nGenerics can be used to type the object being checked. This will default\\nto the declaration passed to the 2nd argument.\\n\\n"},{"kind":"code","text":"```ts\\ninstanceOf(error, Error);\\n```"},{"kind":"text","text":"\\n\\n> Loose checks can be useful if multiple copies of the same class declaration\\n> exists in the module tree. For example, multiple versions of the same package are imported."}]},"sources":[{"fileName":"packages/common/src/helpers/instanceOf.ts","line":32,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/instanceOf.ts#L32"}],"typeParameter":[{"id":2709,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":2710,"name":"object","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":2711,"name":"declaration","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2947,"typeArguments":[{"type":"reference","target":2709,"name":"T","package":"@boost/common","refersToTypeParameter":true}],"name":"Constructor","package":"@boost/common"}},{"id":2712,"name":"loose","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true"}],"type":{"type":"predicate","name":"object","asserts":false,"targetType":{"type":"reference","target":2709,"name":"T","package":"@boost/common","refersToTypeParameter":true}}}],"permalink":"/api/common/function/instanceOf","previousId":2703,"nextId":2713},{"id":2713,"name":"isEmpty","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isEmpty.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isEmpty.ts#L17"}],"signatures":[{"id":2714,"name":"isEmpty","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`true`"},{"kind":"text","text":" if an object has no properties, an array has no items,\\nor the value is falsy, otherwise, it returns "},{"kind":"code","text":"`false`"},{"kind":"text","text":".\\n\\n"},{"kind":"code","text":"```ts\\nimport { isEmpty } from \'@boost/common\';\\n\\nisEmpty({}); // true\\nisEmpty({ name: \'Boost\' }); // false\\n\\nisEmpty([]); // true\\nisEmpty([\'Boost\']); // false\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isEmpty.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isEmpty.ts#L17"}],"parameters":[{"id":2715,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/common/function/isEmpty","previousId":2707,"nextId":2716},{"id":2716,"name":"isFilePath","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isFilePath.ts","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isFilePath.ts#L20"}],"signatures":[{"id":2717,"name":"isFilePath","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`true`"},{"kind":"text","text":" if a string or "},{"kind":"code","text":"`Path`"},{"kind":"text","text":" instance looks like a file system path,\\nby checking for absolute or relative path markers, or the existence of\\npath separating slashes. Will return "},{"kind":"code","text":"`false`"},{"kind":"text","text":" for values that are only\\nthe file or folder name.\\n\\n"},{"kind":"code","text":"```ts\\nimport { isFilePath } from \'@boost/common\';\\n\\nisFilePath(\'./path/to/file.ts\'); // true\\nisFilePath(new Path(\'/path/to/folder\')); // true\\nisFilePath(\'file.ts\'); // false\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isFilePath.ts","line":20,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isFilePath.ts#L20"}],"parameters":[{"id":2718,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/common/function/isFilePath","previousId":2713,"nextId":2719},{"id":2719,"name":"isModuleName","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isModuleName.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isModuleName.ts#L21"}],"signatures":[{"id":2720,"name":"isModuleName","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`true`"},{"kind":"text","text":" if a string is a valid Node module package name,\\naccording to the rules defined in\\n[validate-npm-package-name](https://github.com/npm/validate-npm-package-name).\\nWill "},{"kind":"code","text":"`return`"},{"kind":"text","text":" false for native builtin modules, like "},{"kind":"code","text":"`fs`"},{"kind":"text","text":", and for the old name format.\\n\\n"},{"kind":"code","text":"```ts\\nimport { isModuleName } from \'@boost/common\';\\n\\nisModuleName(\'boost\'); // true\\nisModuleName(\'@boost/common\'); // true\\nisModuleName(\'fs\'); // false\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isModuleName.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isModuleName.ts#L21"}],"parameters":[{"id":2721,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/common/function/isModuleName","previousId":2716,"nextId":2722},{"id":2722,"name":"isObject","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isObject.ts","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isObject.ts#L24"}],"signatures":[{"id":2723,"name":"isObject","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns "},{"kind":"code","text":"`true`"},{"kind":"text","text":" if the value is an object.\\n\\n"},{"kind":"code","text":"```ts\\nimport { isObject } from \'@boost/common\';\\n\\nisObject({}); // true\\nisObject(new Foo()); // true\\nisObject([]); // false\\n```"},{"kind":"text","text":"\\n\\nGenerics can be used to type the return value of the object (when necessary).\\n\\n"},{"kind":"code","text":"```ts\\ninterface Person {\\n\\tname: string;\\n}\\n\\nif (isObject(person)) {\\n\\tconsole.log(person.name);\\n}\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isObject.ts","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isObject.ts#L24"}],"typeParameter":[{"id":2724,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2725,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"predicate","name":"value","asserts":false,"targetType":{"type":"reference","target":2724,"name":"T","package":"@boost/common","refersToTypeParameter":true}}}],"permalink":"/api/common/function/isObject","previousId":2719,"nextId":2726},{"id":2726,"name":"isPlainObject","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/isPlainObject.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isPlainObject.ts#L17"}],"signatures":[{"id":2727,"name":"isPlainObject","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`isObject`"},{"kind":"text","text":" but only returns true if the value is a plain object\\n(no class instances, built-ins, etc). It achieves this by comparing\\nthe value\'s prototype to the built-in "},{"kind":"code","text":"`Object`"},{"kind":"text","text":" types. If you need to\\nrun these checks for cross-realm objects, pass true to the "},{"kind":"code","text":"`loose`"},{"kind":"text","text":" argument.\\n\\n"},{"kind":"code","text":"```ts\\nimport { isPlainObject } from \'@boost/common\';\\n\\nisPlainObject({}); // true\\nisPlainObject(new Foo()); // false\\nisPlainObject([]); // false\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/isPlainObject.ts","line":17,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/isPlainObject.ts#L17"}],"typeParameter":[{"id":2728,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":2729,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":2730,"name":"loose","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"predicate","name":"value","asserts":false,"targetType":{"type":"reference","target":2728,"name":"T","package":"@boost/common","refersToTypeParameter":true}}}],"permalink":"/api/common/function/isPlainObject","previousId":2722,"nextId":2731},{"id":2731,"name":"toArray","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/helpers/toArray.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/toArray.ts#L14"}],"signatures":[{"id":2732,"name":"toArray","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Converts a non-array to an array. If the provided value is falsy,\\nan empty array is returned. If the provided value is truthy and a\\nnon-array, an array of 1 item is returned.\\n\\n"},{"kind":"code","text":"```ts\\nimport { toArray } from \'@boost/common\';\\n\\ntoArray(123); // [123]\\ntoArray(\'abc\'); // [\'abc\']\\ntoArray([\'a\', \'b\', \'c\']); // [\'a\', \'b\', \'c\']\\n```"}]},"sources":[{"fileName":"packages/common/src/helpers/toArray.ts","line":14,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/helpers/toArray.ts#L14"}],"typeParameter":[{"id":2733,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":2734,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":2733,"name":"T","package":"@boost/common","refersToTypeParameter":true},{"type":"array","elementType":{"type":"reference","target":2733,"name":"T","package":"@boost/common","refersToTypeParameter":true}}]}}],"type":{"type":"array","elementType":{"type":"reference","target":2733,"name":"T","package":"@boost/common","refersToTypeParameter":true}}}],"permalink":"/api/common/function/toArray","previousId":2726,"nextId":2965}],"groups":[{"title":"Classes","children":[2659,2678,2735,2763,2802,2859,2890,3055]},{"title":"Functions","children":[3112,3114,3117,3125,3148,2684,2688,2692,2703,2707,2713,2716,2719,2722,2726,2731]},{"title":"Interfaces","children":[2965,2969,2929,3143,2955,3041,3037,2986,2913,2976,2978,2888,2982,2933,2960,2973,3045,3051]},{"title":"Namespaces","children":[2610,2637]},{"title":"Type Aliases","children":[2937,2949,2651,2942,2964,2947,2968,2927,2701,2928,3138,3134,3129,2698,2699,2700,2921,2922,2920,2962]},{"title":"Variables","children":[2652,2657,2658]}],"sources":[{"fileName":"packages/common/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/index.ts#L1"}],"permalink":"/api/common"},"urlSlug":"common"},{"index":false,"label":"Optimal","reflection":{"id":89,"name":"@boost/common/optimal","variant":"declaration","kind":2,"flags":{},"children":[{"id":90,"name":"portablePathSchema","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"A schema for validating a value is a "},{"kind":"code","text":"`PortablePath`"},{"kind":"text","text":".\\nChecks for a string, "},{"kind":"code","text":"`Path`"},{"kind":"text","text":", or "},{"kind":"code","text":"`Pathable`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/common/src/optimal.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/optimal.ts#L11"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/union.d.ts","qualifiedName":"UnionSchema"},"typeArguments":[{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}],"name":"UnionSchema","package":"optimal"},"defaultValue":"...","permalink":"/api/common-optimal#portablePathSchema"}],"groups":[{"title":"Variables","children":[90]}],"sources":[{"fileName":"packages/common/src/optimal.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/optimal.ts#L1"}],"permalink":"/api/common-optimal"},"urlSlug":"common-optimal"},{"index":false,"label":"Test utilities","reflection":{"id":75,"name":"@boost/common/test","variant":"declaration","kind":2,"flags":{},"children":[{"id":80,"name":"mockFilePath","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":19,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L19"}],"signatures":[{"id":81,"name":"mockFilePath","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":19,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L19"}],"parameters":[{"id":82,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}],"permalink":"/api/common-test/function/mockFilePath","nextId":86},{"id":86,"name":"mockModulePath","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":30,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L30"}],"signatures":[{"id":87,"name":"mockModulePath","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":30,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L30"}],"parameters":[{"id":88,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2735,"name":"ModulePath","package":"@boost/common"}}],"permalink":"/api/common-test/function/mockModulePath","previousId":80,"nextId":83},{"id":83,"name":"mockNormalizedFilePath","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L23"}],"signatures":[{"id":84,"name":"mockNormalizedFilePath","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L23"}],"parameters":[{"id":85,"name":"parts","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}}],"type":{"type":"reference","target":2802,"name":"Path","package":"@boost/common"}}],"permalink":"/api/common-test/function/mockNormalizedFilePath","previousId":86,"nextId":76},{"id":76,"name":"normalizeSeparators","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/common/src/test.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L7"}],"signatures":[{"id":77,"name":"normalizeSeparators","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Normalize a path or its parts by ensuring all path separators match\\nthe operating systems default character."}]},"sources":[{"fileName":"packages/common/src/test.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L7"}],"typeParameter":[{"id":78,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"},{"type":"array","elementType":{"type":"reference","target":2920,"name":"PortablePath","package":"@boost/common"}}]}}],"parameters":[{"id":79,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":78,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"type":{"type":"reference","target":78,"name":"T","package":"@boost/common","refersToTypeParameter":true}}],"permalink":"/api/common-test/function/normalizeSeparators","previousId":83}],"groups":[{"title":"Functions","children":[80,86,83,76]}],"sources":[{"fileName":"packages/common/src/test.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/common/src/test.ts#L1"}],"permalink":"/api/common-test"},"urlSlug":"common-test"}],"packageName":"@boost/common","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":2,"name":"@boost/config","variant":"declaration","kind":2,"flags":{},"children":[{"id":347,"name":"Configuration","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":348,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":44,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L44"}],"signatures":[{"id":349,"name":"new Configuration","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":44,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L44"}],"typeParameter":[{"id":350,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":351,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":352,"name":"resolver","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"ModuleResolver"},"name":"ModuleResolver","package":"@boost/common"}}],"type":{"type":"reference","target":347,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Configuration","package":"@boost/config"},"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":353,"name":"onLoadedConfig","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after config files are loaded but before processed. Can modify config file list."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":22,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L22"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/WaterfallEvent.ts","qualifiedName":"WaterfallEvent"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":479,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"ConfigFile","package":"@boost/config"}},{"type":"intrinsic","name":"string"}],"name":"WaterfallEvent","package":"@boost/event"},"defaultValue":"..."},{"id":354,"name":"onLoadedIgnore","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after ignore files are loaded. Can modify ignore file list."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":28,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L28"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/WaterfallEvent.ts","qualifiedName":"WaterfallEvent"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":484,"name":"IgnoreFile","package":"@boost/config"}},{"type":"intrinsic","name":"string"}],"name":"WaterfallEvent","package":"@boost/event"},"defaultValue":"..."},{"id":355,"name":"onProcessedConfig","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after config files are loaded and processed."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":34,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L34"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":407,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":384,"name":"addProcessHandler","variant":"declaration","kind":2048,"flags":{"isPublic":true},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":150,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L150"}],"signatures":[{"id":385,"name":"addProcessHandler","variant":"signature","kind":4096,"flags":{"isPublic":true},"comment":{"summary":[{"kind":"text","text":"Add a process handler to customize the processing of key-value setting pairs.\\nMay only run a processor on settings found in the root of the configuration object."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":150,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L150"}],"typeParameter":[{"id":386,"name":"K","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"number"},{"type":"intrinsic","name":"symbol"}]}},{"id":387,"name":"V","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"indexedAccess","indexType":{"type":"reference","target":386,"name":"K","package":"@boost/config","refersToTypeParameter":true},"objectType":{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}}}],"parameters":[{"id":388,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":386,"name":"K","package":"@boost/config","refersToTypeParameter":true}},{"id":389,"name":"handler","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":468,"typeArguments":[{"type":"reference","target":387,"name":"V","package":"@boost/config","refersToTypeParameter":true}],"name":"Handler","package":"@boost/config"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":414,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"signatures":[{"id":415,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"parameters":[{"id":416,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":417,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":390,"name":"bootstrap","variant":"declaration","kind":2048,"flags":{"isPublic":true},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":160,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L160"}],"signatures":[{"id":391,"name":"bootstrap","variant":"signature","kind":4096,"flags":{"isPublic":true},"comment":{"summary":[{"kind":"text","text":"Life cycle called on initialization."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":160,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L160"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":360,"name":"clearCache","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":57,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L57"}],"signatures":[{"id":361,"name":"clearCache","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clear all cache."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":57,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L57"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":362,"name":"clearFileCache","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L67"}],"signatures":[{"id":363,"name":"clearFileCache","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clear all cached file contents."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":67,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L67"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":364,"name":"clearFinderCache","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L76"}],"signatures":[{"id":365,"name":"clearFinderCache","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Clear all cached directory and file path information."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L76"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":408,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":409,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":410,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":411,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":412,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":413,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":392,"name":"configureFinder","variant":"declaration","kind":2048,"flags":{"isPublic":true},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":166,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L166"}],"signatures":[{"id":393,"name":"configureFinder","variant":"signature","kind":4096,"flags":{"isPublic":true},"comment":{"summary":[{"kind":"text","text":"Configure the finder instance."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":166,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L166"}],"parameters":[{"id":394,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":495,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"ConfigFinderOptions","package":"@boost/config"},{"type":"literal","value":"name"}],"name":"Omit","package":"typescript"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":395,"name":"configureProcessor","variant":"declaration","kind":2048,"flags":{"isPublic":true},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":176,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L176"}],"signatures":[{"id":396,"name":"configureProcessor","variant":"signature","kind":4096,"flags":{"isPublic":true},"comment":{"summary":[{"kind":"text","text":"Configure the processor instance."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":176,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L176"}],"parameters":[{"id":397,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Omit"},"typeArguments":[{"type":"reference","target":516,"name":"ProcessorOptions","package":"@boost/config"},{"type":"literal","value":"name"}],"name":"Omit","package":"typescript"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":366,"name":"findRootDir","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":87,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L87"}],"signatures":[{"id":367,"name":"findRootDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Attempt to find the root directory starting from the provided directory.\\nOnce the root is found, it will be cached for further lookups,\\notherwise an error is thrown based on current configuration."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":87,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L87"}],"parameters":[{"id":368,"name":"fromDir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},"defaultValue":"..."}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"}],"name":"Promise","package":"typescript"}}]},{"id":369,"name":"loadConfigFromBranchToRoot","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":96,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L96"}],"signatures":[{"id":370,"name":"loadConfigFromBranchToRoot","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Traverse upwards from the branch directory, until the root directory is found,\\nor we reach to top of the file system. While traversing, find all config files\\nwithin each branch directory, and the root."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":96,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L96"}],"parameters":[{"id":371,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":488,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"ProcessedConfig","package":"@boost/config"}],"name":"Promise","package":"typescript"}}]},{"id":372,"name":"loadConfigFromRoot","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":106,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L106"}],"signatures":[{"id":373,"name":"loadConfigFromRoot","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Load config files from the defined root. Root is determined by a relative\\n"},{"kind":"code","text":"`.config`"},{"kind":"text","text":" folder and "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" file."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":106,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L106"}],"parameters":[{"id":374,"name":"fromDir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},"defaultValue":"..."}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":488,"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"ProcessedConfig","package":"@boost/config"}],"name":"Promise","package":"typescript"}}]},{"id":375,"name":"loadIgnoreFromBranchToRoot","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":117,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L117"}],"signatures":[{"id":376,"name":"loadIgnoreFromBranchToRoot","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Traverse upwards from the branch directory, until the root directory is found,\\nor we reach to top of the file system. While traversing, find all ignore files\\nwithin each branch directory, and the root."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":117,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L117"}],"parameters":[{"id":377,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":484,"name":"IgnoreFile","package":"@boost/config"}}],"name":"Promise","package":"typescript"}}]},{"id":378,"name":"loadIgnoreFromRoot","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":127,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L127"}],"signatures":[{"id":379,"name":"loadIgnoreFromRoot","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Load ignore file from the defined root. Root is determined by a relative\\n"},{"kind":"code","text":"`.config`"},{"kind":"text","text":" folder and "},{"kind":"code","text":"`package.json`"},{"kind":"text","text":" file."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":127,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L127"}],"parameters":[{"id":380,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},"defaultValue":"..."}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":484,"name":"IgnoreFile","package":"@boost/config"}}],"name":"Promise","package":"typescript"}}]},{"id":381,"name":"setRootDir","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":139,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L139"}],"signatures":[{"id":382,"name":"setRootDir","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Explicitly set the root directory to stop traversal at. This should only be set\\nmanually when you want full control, and know file boundaries up front.\\n\\nThis *does not* check for the existence of the root config file or folder."}]},"sources":[{"fileName":"packages/config/src/Configuration.ts","line":139,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L139"}],"parameters":[{"id":383,"name":"dir","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[348]},{"title":"Properties","children":[353,354,355,407]},{"title":"Methods","children":[384,414,390,360,362,364,408,392,395,366,369,372,375,378,381]}],"categories":[{"title":"Events","children":[353,354,355]},{"title":"__CATEGORY__","children":[348,407,384,414,390,360,362,364,408,392,395,366,369,372,375,378,381]}],"sources":[{"fileName":"packages/config/src/Configuration.ts","line":17,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/Configuration.ts#L17"}],"typeParameters":[{"id":418,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":350,"name":"T","package":"@boost/config","qualifiedName":"Configuration.T","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}],"permalink":"/api/config/class/Configuration","nextId":445},{"id":492,"name":"BaseFinderOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":494,"name":"errorIfNoRootFound","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error if the root config cannot be located."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L45"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":493,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of files, without extension."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L43"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[494,493]}],"sources":[{"fileName":"packages/config/src/types.ts","line":41,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L41"}],"extendedBy":[{"type":"reference","target":495,"name":"ConfigFinderOptions"},{"type":"reference","target":513,"name":"IgnoreFinderOptions"}],"permalink":"/api/config/interface/BaseFinderOptions","previousId":440,"nextId":479},{"id":479,"name":"ConfigFile","variant":"declaration","kind":256,"flags":{},"children":[{"id":480,"name":"config","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Config content of the file."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L25"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"DeepPartial"},"typeArguments":[{"type":"reference","target":483,"name":"T","package":"@boost/config","qualifiedName":"ConfigFile.T","refersToTypeParameter":true}],"name":"DeepPartial","package":"optimal"}},{"id":481,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute path of the file."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":477,"name":"File.path"}},{"id":482,"name":"source","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The source where the file originated."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L20"}],"type":{"type":"reference","target":475,"name":"FileSource","package":"@boost/config"},"inheritedFrom":{"type":"reference","target":478,"name":"File.source"}}],"groups":[{"title":"Properties","children":[480,481,482]}],"sources":[{"fileName":"packages/config/src/types.ts","line":23,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L23"}],"typeParameters":[{"id":483,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"extendedTypes":[{"type":"reference","target":476,"name":"File","package":"@boost/config"}],"permalink":"/api/config/interface/ConfigFile","previousId":492,"nextId":495},{"id":495,"name":"ConfigFinderOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":511,"name":"errorIfNoRootFound","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error if the root config cannot be located."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L45"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":494,"name":"BaseFinderOptions.errorIfNoRootFound"}},{"id":496,"name":"extendsSetting","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Name of the setting in which \\"config extending\\" is enabled."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L50"}],"type":{"type":"intrinsic","name":"string"}},{"id":497,"name":"extensions","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of extensions, in order, to find config files within each folder. Defaults to built-in file format list."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":52,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L52"}],"type":{"type":"array","elementType":{"type":"reference","target":460,"name":"ExtType","package":"@boost/config"}}},{"id":498,"name":"includeEnv","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Find and load environment based config files (using "},{"kind":"code","text":"`NODE_ENV`"},{"kind":"text","text":"). Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":54,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L54"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":499,"name":"loaders","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Mapping of loader functions by type. Defaults to built-in file type loaders."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":56,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L56"}],"type":{"type":"reflection","declaration":{"id":500,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":501,"name":"cjs","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":502,"name":"js","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":503,"name":"json","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":504,"name":"json5","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":505,"name":"mjs","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":506,"name":"ts","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}},{"id":507,"name":"yaml","variant":"declaration","kind":1024,"flags":{},"type":{"type":"reference","target":462,"typeArguments":[{"type":"reference","target":512,"name":"T","package":"@boost/config","qualifiedName":"ConfigFinderOptions.T","refersToTypeParameter":true}],"name":"Loader","package":"@boost/config"}}],"groups":[{"title":"Properties","children":[501,502,503,504,505,506,507]}],"sources":[{"fileName":"packages/config/src/types.ts","line":56,"character":11,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L56"}]}}},{"id":510,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of files, without extension."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L43"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":493,"name":"BaseFinderOptions.name"}},{"id":508,"name":"overridesSetting","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Name of the setting in which \\"config overriding\\" is enabled."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L58"}],"type":{"type":"intrinsic","name":"string"}},{"id":509,"name":"resolver","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom module resolver."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":60,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L60"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"ModuleResolver"},"name":"ModuleResolver","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[511,496,497,498,499,510,508,509]}],"sources":[{"fileName":"packages/config/src/types.ts","line":48,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L48"}],"typeParameters":[{"id":512,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"extendedTypes":[{"type":"reference","target":492,"name":"BaseFinderOptions","package":"@boost/config"}],"permalink":"/api/config/interface/ConfigFinderOptions","previousId":479,"nextId":476},{"id":476,"name":"File","variant":"declaration","kind":256,"flags":{},"children":[{"id":477,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute path of the file."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"}},{"id":478,"name":"source","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The source where the file originated."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L20"}],"type":{"type":"reference","target":475,"name":"FileSource","package":"@boost/config"}}],"groups":[{"title":"Properties","children":[477,478]}],"sources":[{"fileName":"packages/config/src/types.ts","line":16,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L16"}],"extendedBy":[{"type":"reference","target":479,"name":"ConfigFile"},{"type":"reference","target":484,"name":"IgnoreFile"}],"permalink":"/api/config/interface/File","previousId":495,"nextId":484},{"id":484,"name":"IgnoreFile","variant":"declaration","kind":256,"flags":{},"children":[{"id":485,"name":"ignore","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Ignored content of the file, split on new lines."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L30"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":486,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute path of the file."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":477,"name":"File.path"}},{"id":487,"name":"source","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The source where the file originated."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L20"}],"type":{"type":"reference","target":475,"name":"FileSource","package":"@boost/config"},"inheritedFrom":{"type":"reference","target":478,"name":"File.source"}}],"groups":[{"title":"Properties","children":[485,486,487]}],"sources":[{"fileName":"packages/config/src/types.ts","line":28,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L28"}],"extendedTypes":[{"type":"reference","target":476,"name":"File","package":"@boost/config"}],"permalink":"/api/config/interface/IgnoreFile","previousId":476,"nextId":513},{"id":513,"name":"IgnoreFinderOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":515,"name":"errorIfNoRootFound","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Throw an error if the root config cannot be located."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L45"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":494,"name":"BaseFinderOptions.errorIfNoRootFound"}},{"id":514,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of files, without extension."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L43"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":493,"name":"BaseFinderOptions.name"}}],"groups":[{"title":"Properties","children":[515,514]}],"sources":[{"fileName":"packages/config/src/types.ts","line":63,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L63"}],"extendedTypes":[{"type":"reference","target":492,"name":"BaseFinderOptions","package":"@boost/config"}],"permalink":"/api/config/interface/IgnoreFinderOptions","previousId":484,"nextId":522},{"id":522,"name":"OverridesSettingItem","variant":"declaration","kind":256,"flags":{},"children":[{"id":523,"name":"exclude","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"File path patterns/globs to ignore."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L84"}],"type":{"type":"reference","target":520,"name":"FileGlob","package":"@boost/config"}},{"id":524,"name":"include","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"File path patterns/globs to match against."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":86,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L86"}],"type":{"type":"reference","target":520,"name":"FileGlob","package":"@boost/config"}},{"id":525,"name":"settings","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Settings configured for this specific override."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":88,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L88"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"DeepPartial"},"typeArguments":[{"type":"reference","target":526,"name":"T","package":"@boost/config","qualifiedName":"OverridesSettingItem.T","refersToTypeParameter":true}],"name":"DeepPartial","package":"optimal"}}],"groups":[{"title":"Properties","children":[523,524,525]}],"sources":[{"fileName":"packages/config/src/types.ts","line":82,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L82"}],"typeParameters":[{"id":526,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/config/interface/OverridesSettingItem","previousId":513,"nextId":488},{"id":488,"name":"ProcessedConfig","variant":"declaration","kind":256,"flags":{},"children":[{"id":489,"name":"config","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"All found and loaded config file contents merged and processed into a\\nsingle config object."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":491,"name":"T","package":"@boost/config","qualifiedName":"ProcessedConfig.T","refersToTypeParameter":true}],"name":"Required","package":"typescript"}},{"id":490,"name":"files","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of config files found and loaded."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L38"}],"type":{"type":"array","elementType":{"type":"reference","target":479,"typeArguments":[{"type":"reference","target":491,"name":"T","package":"@boost/config","qualifiedName":"ProcessedConfig.T","refersToTypeParameter":true}],"name":"ConfigFile","package":"@boost/config"}}}],"groups":[{"title":"Properties","children":[489,490]}],"sources":[{"fileName":"packages/config/src/types.ts","line":33,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L33"}],"typeParameters":[{"id":491,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/config/interface/ProcessedConfig","previousId":522,"nextId":516},{"id":516,"name":"ProcessorOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":517,"name":"defaultWhenUndefined","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"When a setting has a value of "},{"kind":"code","text":"`undefined`"},{"kind":"text","text":", fallback to the\\ndefault/initial value for that setting. Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L70"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":518,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of config files, without extension."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":72,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L72"}],"type":{"type":"intrinsic","name":"string"}},{"id":519,"name":"validate","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Validate all settings within a config file before processing. Defaults to\\n"},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/config/src/types.ts","line":75,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L75"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[517,518,519]}],"sources":[{"fileName":"packages/config/src/types.ts","line":65,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L65"}],"permalink":"/api/config/interface/ProcessorOptions","previousId":488,"nextId":341},{"id":341,"name":"ConfigErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/ConfigError.ts","line":15,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/ConfigError.ts#L15"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/config/src/ConfigError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/config","preferValues":true}}},"permalink":"/api/config#ConfigErrorCode","previousId":516,"nextId":460},{"id":460,"name":"ExtType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":4,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L4"}],"type":{"type":"union","types":[{"type":"literal","value":"cjs"},{"type":"literal","value":"js"},{"type":"literal","value":"json"},{"type":"literal","value":"json5"},{"type":"literal","value":"mjs"},{"type":"literal","value":"ts"},{"type":"literal","value":"yaml"},{"type":"literal","value":"yml"}]},"permalink":"/api/config#ExtType","previousId":341,"nextId":521},{"id":521,"name":"ExtendsSetting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":80,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L80"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"intrinsic","name":"string"}]},"permalink":"/api/config#ExtendsSetting","previousId":460,"nextId":520},{"id":520,"name":"FileGlob","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":78,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L78"}],"type":{"type":"union","types":[{"type":"array","elementType":{"type":"intrinsic","name":"string"}},{"type":"intrinsic","name":"string"}]},"permalink":"/api/config#FileGlob","previousId":521,"nextId":475},{"id":475,"name":"FileSource","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":14,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L14"}],"type":{"type":"union","types":[{"type":"literal","value":"branch"},{"type":"literal","value":"extended"},{"type":"literal","value":"overridden"},{"type":"literal","value":"root"}]},"permalink":"/api/config#FileSource","previousId":520,"nextId":474},{"id":474,"name":"FileType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":12,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L12"}],"type":{"type":"union","types":[{"type":"literal","value":"branch"},{"type":"literal","value":"preset"},{"type":"literal","value":"root-file"},{"type":"literal","value":"root-folder"}]},"permalink":"/api/config#FileType","previousId":475,"nextId":468},{"id":468,"name":"Handler","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":10,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L10"}],"typeParameters":[{"id":473,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":469,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":10,"character":25,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L10"}],"signatures":[{"id":470,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":471,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":473,"name":"T","package":"@boost/config","refersToTypeParameter":true}},{"id":472,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":473,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"union","types":[{"type":"reference","target":473,"name":"T","package":"@boost/config","refersToTypeParameter":true},{"type":"intrinsic","name":"undefined"}]}],"name":"Promise","package":"typescript"},{"type":"reference","target":473,"name":"T","package":"@boost/config","refersToTypeParameter":true},{"type":"intrinsic","name":"undefined"}]}}]}},"permalink":"/api/config#Handler","previousId":474,"nextId":462},{"id":462,"name":"Loader","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":8,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L8"}],"typeParameters":[{"id":467,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":463,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":8,"character":24,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L8"}],"signatures":[{"id":464,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":465,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"}},{"id":466,"name":"pkg","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PackageStructure"},"name":"PackageStructure","package":"@boost/common"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"DeepPartial"},"typeArguments":[{"type":"reference","target":467,"name":"T","package":"@boost/config","refersToTypeParameter":true}],"name":"DeepPartial","package":"optimal"}],"name":"Promise","package":"typescript"}}]}},"permalink":"/api/config#Loader","previousId":468,"nextId":461},{"id":461,"name":"LoaderType","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":6,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L6"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Exclude"},"typeArguments":[{"type":"reference","target":460,"name":"ExtType","package":"@boost/config"},{"type":"literal","value":"yml"}],"name":"Exclude","package":"typescript"},"permalink":"/api/config#LoaderType","previousId":462,"nextId":527},{"id":527,"name":"OverridesSetting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":91,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L91"}],"typeParameters":[{"id":528,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"array","elementType":{"type":"reference","target":522,"typeArguments":[{"type":"reference","target":528,"name":"T","package":"@boost/config","refersToTypeParameter":true}],"name":"OverridesSettingItem","package":"@boost/config"}},"permalink":"/api/config#OverridesSetting","previousId":461,"nextId":530},{"id":530,"name":"PluginEntry","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":97,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L97"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"reference","target":529,"name":"PluginOptions","package":"@boost/config"}]}]},"permalink":"/api/config#PluginEntry","previousId":527,"nextId":529},{"id":529,"name":"PluginOptions","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":95,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L95"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"object"}]},"permalink":"/api/config#PluginOptions","previousId":530,"nextId":533},{"id":533,"name":"PluginsSetting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":103,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L103"}],"type":{"type":"union","types":[{"type":"reference","target":532,"name":"PluginsSettingList","package":"@boost/config"},{"type":"reference","target":531,"name":"PluginsSettingMap","package":"@boost/config"}]},"permalink":"/api/config#PluginsSetting","previousId":529,"nextId":532},{"id":532,"name":"PluginsSettingList","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":101,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L101"}],"type":{"type":"array","elementType":{"type":"reference","target":530,"name":"PluginEntry","package":"@boost/config"}},"permalink":"/api/config#PluginsSettingList","previousId":533,"nextId":531},{"id":531,"name":"PluginsSettingMap","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/config/src/types.ts","line":99,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/types.ts#L99"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":529,"name":"PluginOptions","package":"@boost/config"}],"name":"Record","package":"typescript"},"permalink":"/api/config#PluginsSettingMap","previousId":532,"nextId":342},{"id":342,"name":"ConfigError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/config/src/ConfigError.ts","line":17,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/ConfigError.ts#L17"}],"type":{"type":"reflection","declaration":{"id":343,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":344,"name":"new ConfigError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":345,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"EXTENDS_ONLY_ROOT"},{"type":"literal","value":"EXTENDS_UNKNOWN_PATH"},{"type":"literal","value":"LOADER_UNSUPPORTED"},{"type":"literal","value":"PACKAGE_UNKNOWN_SCOPE"},{"type":"literal","value":"ROOT_INVALID"},{"type":"literal","value":"ROOT_INVALID_DIR"},{"type":"literal","value":"ROOT_NO_PACKAGE"},{"type":"literal","value":"ROOT_ONLY_OVERRIDES"}]}},{"id":346,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"EXTENDS_ONLY_ROOT"},{"type":"literal","value":"EXTENDS_UNKNOWN_PATH"},{"type":"literal","value":"LOADER_UNSUPPORTED"},{"type":"literal","value":"PACKAGE_UNKNOWN_SCOPE"},{"type":"literal","value":"ROOT_INVALID"},{"type":"literal","value":"ROOT_INVALID_DIR"},{"type":"literal","value":"ROOT_NO_PACKAGE"},{"type":"literal","value":"ROOT_ONLY_OVERRIDES"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/config#ConfigError","previousId":531},{"id":445,"name":"createExtendsSchema","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L13"}],"signatures":[{"id":446,"name":"createExtendsSchema","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" schema for validating the structure of an \\"extends\\" setting."}]},"sources":[{"fileName":"packages/config/src/schemas.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L13"}],"parameters":[{"id":447,"name":"schematics","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"},"defaultValue":"schemas"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/union.d.ts","qualifiedName":"UnionSchema"},"typeArguments":[{"type":"reference","target":521,"name":"ExtendsSetting","package":"@boost/config"}],"name":"UnionSchema","package":"optimal"}}],"permalink":"/api/config/function/createExtendsSchema","previousId":347,"nextId":451},{"id":451,"name":"createOverridesSchema","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":39,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L39"}],"signatures":[{"id":452,"name":"createOverridesSchema","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" schema for validating the structure of an \\"overrides\\" setting."}]},"sources":[{"fileName":"packages/config/src/schemas.ts","line":39,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L39"}],"typeParameter":[{"id":453,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":454,"name":"blueprint","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":453,"name":"T","package":"@boost/config","refersToTypeParameter":true}],"name":"Blueprint","package":"optimal"}},{"id":455,"name":"schematics","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"},"defaultValue":"schemas"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/array.d.ts","qualifiedName":"ArraySchema"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":456,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":457,"name":"exclude","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":48,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L48"}],"type":{"type":"reference","target":520,"name":"FileGlob","package":"@boost/config"},"defaultValue":"..."},{"id":458,"name":"include","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":49,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L49"}],"type":{"type":"reference","target":520,"name":"FileGlob","package":"@boost/config"},"defaultValue":"..."},{"id":459,"name":"settings","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":50,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L50"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"NotNull"},"typeArguments":[{"type":"reference","target":453,"name":"T","package":"@boost/config","refersToTypeParameter":true}],"name":"NotNull","package":"optimal"}],"name":"Required","package":"typescript"},"defaultValue":"..."}],"groups":[{"title":"Properties","children":[457,458,459]}]}}],"name":"Required","package":"typescript"}}],"name":"ArraySchema","package":"optimal"}}],"permalink":"/api/config/function/createOverridesSchema","previousId":445,"nextId":448},{"id":448,"name":"createPluginsSchema","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/schemas.ts","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L24"}],"signatures":[{"id":449,"name":"createPluginsSchema","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" schema for validating the structure of a \\"plugins\\" setting."}]},"sources":[{"fileName":"packages/config/src/schemas.ts","line":24,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/schemas.ts#L24"}],"parameters":[{"id":450,"name":"schematics","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"},"defaultValue":"schemas"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/union.d.ts","qualifiedName":"UnionSchema"},"typeArguments":[{"type":"reference","target":533,"name":"PluginsSetting","package":"@boost/config"}],"name":"UnionSchema","package":"optimal"}}],"permalink":"/api/config/function/createPluginsSchema","previousId":451,"nextId":419},{"id":419,"name":"getEnv","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/getEnv.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/getEnv.ts#L4"}],"signatures":[{"id":420,"name":"getEnv","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Detect the current environment name from "},{"kind":"code","text":"`_ENV`"},{"kind":"text","text":" and "},{"kind":"code","text":"`NODE_ENV`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/config/src/helpers/getEnv.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/getEnv.ts#L4"}],"parameters":[{"id":421,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/config/function/getEnv","previousId":448,"nextId":422},{"id":422,"name":"mergeArray","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/mergeArray.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeArray.ts#L4"}],"signatures":[{"id":423,"name":"mergeArray","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Merges previous and next arrays into a new array while removing duplicates (using "},{"kind":"code","text":"`Set`"},{"kind":"text","text":")."}]},"sources":[{"fileName":"packages/config/src/helpers/mergeArray.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeArray.ts#L4"}],"typeParameter":[{"id":424,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"parameters":[{"id":425,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":424,"name":"T","package":"@boost/config","refersToTypeParameter":true}},{"id":426,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":424,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"type":{"type":"reference","target":424,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"permalink":"/api/config/function/mergeArray","previousId":419,"nextId":427},{"id":427,"name":"mergeExtends","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/mergeExtends.ts","line":9,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeExtends.ts#L9"}],"signatures":[{"id":428,"name":"mergeExtends","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Merges previous and next file paths (either a string or array of strings) into a\\nnew list of file paths. This is useful if utilizing config extending."}]},"sources":[{"fileName":"packages/config/src/helpers/mergeExtends.ts","line":9,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeExtends.ts#L9"}],"parameters":[{"id":429,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":521,"name":"ExtendsSetting","package":"@boost/config"}},{"id":430,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":521,"name":"ExtendsSetting","package":"@boost/config"}}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"permalink":"/api/config/function/mergeExtends","previousId":422,"nextId":431},{"id":431,"name":"mergeObject","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/mergeObject.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeObject.ts#L4"}],"signatures":[{"id":432,"name":"mergeObject","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Shallow merges previous and next objects into a new object using object spread."}]},"sources":[{"fileName":"packages/config/src/helpers/mergeObject.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergeObject.ts#L4"}],"typeParameter":[{"id":433,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}}],"parameters":[{"id":434,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":433,"name":"T","package":"@boost/config","refersToTypeParameter":true}},{"id":435,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":433,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"type":{"type":"reference","target":433,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"permalink":"/api/config/function/mergeObject","previousId":427,"nextId":436},{"id":436,"name":"mergePlugins","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/mergePlugins.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergePlugins.ts#L21"}],"signatures":[{"id":437,"name":"mergePlugins","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Merges previous and next plugin configurations into an object.\\nPlugin configs can either be a list of sources, or list of sources\\nwith flags/options (tuples), or a map of sources to flags/options.\\nThis is useful if utilizing the "},{"kind":"code","text":"`@boost/plugin`"},{"kind":"text","text":" package."}]},"sources":[{"fileName":"packages/config/src/helpers/mergePlugins.ts","line":21,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/mergePlugins.ts#L21"}],"parameters":[{"id":438,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":533,"name":"PluginsSetting","package":"@boost/config"}},{"id":439,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":533,"name":"PluginsSetting","package":"@boost/config"}}],"type":{"type":"reference","target":531,"name":"PluginsSettingMap","package":"@boost/config"}}],"permalink":"/api/config/function/mergePlugins","previousId":431,"nextId":440},{"id":440,"name":"overwrite","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/config/src/helpers/overwrite.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/overwrite.ts#L4"}],"signatures":[{"id":441,"name":"overwrite","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Overwrite the previous value with the next value."}]},"sources":[{"fileName":"packages/config/src/helpers/overwrite.ts","line":4,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/helpers/overwrite.ts#L4"}],"typeParameter":[{"id":442,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":443,"name":"prev","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":442,"name":"T","package":"@boost/config","refersToTypeParameter":true}},{"id":444,"name":"next","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":442,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"type":{"type":"reference","target":442,"name":"T","package":"@boost/config","refersToTypeParameter":true}}],"permalink":"/api/config/function/overwrite","previousId":436,"nextId":492}],"groups":[{"title":"Classes","children":[347]},{"title":"Functions","children":[445,451,448,419,422,427,431,436,440]},{"title":"Interfaces","children":[492,479,495,476,484,513,522,488,516]},{"title":"Type Aliases","children":[341,460,521,520,475,474,468,462,461,527,530,529,533,532,531]},{"title":"Variables","children":[342]}],"sources":[{"fileName":"packages/config/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/config/src/index.ts#L1"}],"permalink":"/api/config"},"urlSlug":"config"}],"packageName":"@boost/config","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":91,"name":"@boost/debug","variant":"declaration","kind":2,"flags":{},"children":[{"id":3151,"name":"CrashReporter","variant":"declaration","kind":128,"flags":{},"children":[{"id":3152,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":3153,"name":"new CrashReporter","variant":"signature","kind":16384,"flags":{},"type":{"type":"reference","target":3151,"name":"CrashReporter","package":"@boost/debug"}}]},{"id":3154,"name":"contents","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":38,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L38"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":3155,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L43"}],"signatures":[{"id":3156,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a label with a value, or multiple values, to the last added section."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":43,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L43"}],"parameters":[{"id":3157,"name":"label","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3158,"name":"messages","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}]}}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3159,"name":"addSection","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L53"}],"signatures":[{"id":3160,"name":"addSection","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Start a new section with a title."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L53"}],"parameters":[{"id":3161,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3162,"name":"reportBinaries","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L65"}],"signatures":[{"id":3163,"name":"reportBinaries","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report Node.js related binary versions and paths."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L65"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3164,"name":"reportEnvVars","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L92"}],"signatures":[{"id":3165,"name":"reportEnvVars","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report all environment variables."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":92,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L92"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3166,"name":"reportLanguages","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":107,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L107"}],"signatures":[{"id":3167,"name":"reportLanguages","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report common programming language versions and paths"}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":107,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L107"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3175,"name":"reportPackageVersions","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":202,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L202"}],"signatures":[{"id":3176,"name":"reportPackageVersions","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report npm package versions for all that match the defined pattern.\\nOnly searches in the root node modules folder and _will not_ work with PnP."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":202,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L202"}],"parameters":[{"id":3177,"name":"patterns","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":3178,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'Packages\'"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3168,"name":"reportProcess","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L153"}],"signatures":[{"id":3169,"name":"reportProcess","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report information about the current "},{"kind":"code","text":"`process`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":153,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L153"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3170,"name":"reportStackTrace","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L167"}],"signatures":[{"id":3171,"name":"reportStackTrace","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report the stack trace for a defined "},{"kind":"code","text":"`Error`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":167,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L167"}],"parameters":[{"id":3172,"name":"error","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3173,"name":"reportSystem","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":178,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L178"}],"signatures":[{"id":3174,"name":"reportSystem","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Report information about the platform and operating system."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":178,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L178"}],"type":{"type":"intrinsic","name":"this"}}]},{"id":3179,"name":"write","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":232,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L232"}],"signatures":[{"id":3180,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write the reported content to the defined file path."}]},"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":232,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L232"}],"parameters":[{"id":3181,"name":"filePath","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[3152]},{"title":"Properties","children":[3154]},{"title":"Methods","children":[3155,3159,3162,3164,3166,3175,3168,3170,3173,3179]}],"sources":[{"fileName":"packages/debug/src/CrashReporter.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/CrashReporter.ts#L37"}],"permalink":"/api/debug/class/CrashReporter","nextId":3182},{"id":3185,"name":"Debugger","variant":"declaration","kind":256,"flags":{},"children":[{"id":3186,"name":"disable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all debugger messages from logging to the console."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L7"}],"type":{"type":"reflection","declaration":{"id":3187,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":7,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L7"}],"signatures":[{"id":3188,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all debugger messages from logging to the console."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":7,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L7"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3189,"name":"enable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all debugger messages to log the console."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L9"}],"type":{"type":"reflection","declaration":{"id":3190,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":9,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L9"}],"signatures":[{"id":3191,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all debugger messages to log the console."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":9,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L9"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3192,"name":"invariant","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a pass or fail message based on a conditional."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L11"}],"type":{"type":"reflection","declaration":{"id":3193,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L11"}],"signatures":[{"id":3194,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a pass or fail message based on a conditional."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L11"}],"parameters":[{"id":3195,"name":"condition","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"}},{"id":3196,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3197,"name":"pass","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3198,"name":"fail","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3199,"name":"verbose","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log verbose messages that only appear when the "},{"kind":"code","text":"`BOOSTJS_DEBUG_VERBOSE`"},{"kind":"text","text":" is set."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L13"}],"type":{"type":"reflection","declaration":{"id":3200,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":13,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L13"}],"signatures":[{"id":3201,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log verbose messages that only appear when the "},{"kind":"code","text":"`BOOSTJS_DEBUG_VERBOSE`"},{"kind":"text","text":" is set."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":13,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L13"}],"parameters":[{"id":3202,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3203,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[3186,3189,3192,3199]}],"sources":[{"fileName":"packages/debug/src/types.ts","line":3,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L3"}],"signatures":[{"id":3204,"name":"Debugger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters."}]},"sources":[{"fileName":"packages/debug/src/types.ts","line":5,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L5"}],"parameters":[{"id":3205,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3206,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}},{"id":3207,"name":"Debugger","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/debug/src/types.ts","line":3,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/types.ts#L3"}],"parameters":[{"id":3208,"name":"formatter","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"any"}},{"id":3209,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"void"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../node_modules/@types/debug/index.d.ts","qualifiedName":"debug.IDebugger"},"name":"IDebugger","package":"@types/debug","qualifiedName":"debug.IDebugger"}],"permalink":"/api/debug/interface/Debugger","previousId":3182},{"id":3182,"name":"createDebugger","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/debug/src/createDebugger.ts","line":10,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/createDebugger.ts#L10"}],"signatures":[{"id":3183,"name":"createDebugger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`Debugger`"},{"kind":"text","text":" instance with the defined namespace."}]},"sources":[{"fileName":"packages/debug/src/createDebugger.ts","line":10,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/createDebugger.ts#L10"}],"parameters":[{"id":3184,"name":"namespace","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"type":{"type":"reference","target":3185,"name":"Debugger","package":"@boost/debug"}}],"permalink":"/api/debug/function/createDebugger","previousId":3151,"nextId":3185}],"groups":[{"title":"Classes","children":[3151]},{"title":"Functions","children":[3182]},{"title":"Interfaces","children":[3185]}],"sources":[{"fileName":"packages/debug/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/index.ts#L1"}],"permalink":"/api/debug"},"urlSlug":"debug"},{"index":false,"label":"Test utilities","reflection":{"id":92,"name":"@boost/debug/test","variant":"declaration","kind":2,"flags":{},"children":[{"id":93,"name":"mockDebugger","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/debug/src/test.ts","line":18,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/test.ts#L18"}],"signatures":[{"id":94,"name":"mockDebugger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a Vitest spy that matches the return value shape of "},{"kind":"code","text":"`createDebugger`"},{"kind":"text","text":".\\n\\n"},{"kind":"code","text":"```ts\\nimport { mockDebugger } from \'@boost/debug/test\';\\n\\nit(\'calls the debugger\', async () => {\\n\\tconst debug = await mockDebugger();\\n\\n\\tdebug(\'Something is broken!\');\\n\\n\\texpect(debug).toHaveBeenCalled();\\n});\\n```"}]},"sources":[{"fileName":"packages/debug/src/test.ts","line":18,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/test.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":3185,"name":"Debugger","package":"@boost/debug"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/debug-test/function/mockDebugger"}],"groups":[{"title":"Functions","children":[93]}],"sources":[{"fileName":"packages/debug/src/test.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/debug/src/test.ts#L1"}],"permalink":"/api/debug-test"},"urlSlug":"debug-test"}],"packageName":"@boost/debug","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":3,"name":"@boost/decorators","variant":"declaration","kind":2,"flags":{},"children":[{"id":565,"name":"MemoizeOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":566,"name":"cache","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A custom "},{"kind":"code","text":"`Map`"},{"kind":"text","text":" instance to store cached values. Can also be used to pre-cache expected values."}]},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L17"}],"type":{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":560,"typeArguments":[{"type":"reference","target":569,"name":"T","package":"@boost/decorators","qualifiedName":"MemoizeOptions.T","refersToTypeParameter":true}],"name":"MemoizeCache","package":"@boost/decorators"}]}},{"id":567,"name":"expires","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Time in milliseconds in which to keep the cache alive (TTL).\\nPass "},{"kind":"code","text":"`0`"},{"kind":"text","text":" to cache indefinitely. Defaults to "},{"kind":"code","text":"`0`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L22"}],"type":{"type":"intrinsic","name":"number"}},{"id":568,"name":"hasher","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"A hashing function to determine the cache key. Is passed the method\'s arguments\\nand must return a string. If not provided, arguments are hashed using "},{"kind":"code","text":"`JSON.stringify()`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L27"}],"type":{"type":"reference","target":556,"name":"MemoizeHasher","package":"@boost/decorators"}}],"groups":[{"title":"Properties","children":[566,567,568]}],"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":15,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L15"}],"typeParameters":[{"id":569,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/decorators/interface/MemoizeOptions","previousId":570,"nextId":560},{"id":560,"name":"MemoizeCache","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":7,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L7"}],"typeParameters":[{"id":564,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reflection","declaration":{"id":561,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":562,"name":"time","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":10,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L10"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"number"},{"type":"literal","value":null}]}},{"id":563,"name":"value","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":11,"character":2,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L11"}],"type":{"type":"reference","target":564,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[562,563]}],"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L9"}]}}],"name":"Map","package":"typescript"},"permalink":"/api/decorators#MemoizeCache","previousId":565,"nextId":556},{"id":556,"name":"MemoizeHasher","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L5"}],"type":{"type":"reflection","declaration":{"id":557,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":5,"character":28,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L5"}],"signatures":[{"id":558,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":559,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"string"}}]}},"permalink":"/api/decorators#MemoizeHasher","previousId":560,"nextId":551},{"id":551,"name":"MemoizedFunction","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L3"}],"typeParameters":[{"id":555,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"reflection","declaration":{"id":552,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":3,"character":34,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L3"}],"signatures":[{"id":553,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":554,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"reference","target":555,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}}]}},"permalink":"/api/decorators#MemoizedFunction","previousId":556},{"id":534,"name":"Bind","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Bind.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Bind.ts#L7"}],"signatures":[{"id":535,"name":"Bind","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that automatically binds a class method\'s\\n"},{"kind":"code","text":"`this`"},{"kind":"text","text":" context to its current instance."}]},"sources":[{"fileName":"packages/decorators/src/Bind.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Bind.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/decorators/function/Bind","nextId":536},{"id":536,"name":"Debounce","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Debounce.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Debounce.ts#L7"}],"signatures":[{"id":537,"name":"Debounce","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that delays the execution of the class method\\nby the provided time in milliseconds."}]},"sources":[{"fileName":"packages/decorators/src/Debounce.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Debounce.ts#L7"}],"parameters":[{"id":538,"name":"delay","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/decorators/function/Debounce","previousId":534,"nextId":539},{"id":539,"name":"Deprecate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Deprecate.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Deprecate.ts#L13"}],"signatures":[{"id":540,"name":"Deprecate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A decorator that marks a class declaration, class method,\\nclass property, or method parameter as deprecated by\\nlogging a deprecation message to the console."}]},"sources":[{"fileName":"packages/decorators/src/Deprecate.ts","line":13,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Deprecate.ts#L13"}],"parameters":[{"id":541,"name":"message","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reflection","declaration":{"id":542,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/decorators/src/Deprecate.ts","line":14,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Deprecate.ts#L14"}],"signatures":[{"id":543,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/decorators/src/Deprecate.ts","line":14,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Deprecate.ts#L14"}],"parameters":[{"id":544,"name":"target","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Object"},"name":"Object","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Function"},"name":"Function","package":"typescript"}]}},{"id":545,"name":"property","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"symbol"}]}},{"id":546,"name":"descriptor","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"permalink":"/api/decorators/function/Deprecate","previousId":536,"nextId":547},{"id":547,"name":"Memoize","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L80"}],"signatures":[{"id":548,"name":"Memoize","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that caches the return value of a class method or\\ngetter to consistently and efficiently return the same value."}]},"sources":[{"fileName":"packages/decorators/src/Memoize.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Memoize.ts#L80"}],"typeParameter":[{"id":549,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":550,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":556,"name":"MemoizeHasher","package":"@boost/decorators"},{"type":"reference","target":565,"typeArguments":[{"type":"reference","target":549,"name":"T","package":"@boost/decorators","refersToTypeParameter":true}],"name":"MemoizeOptions","package":"@boost/decorators"}]},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/decorators/function/Memoize","previousId":539,"nextId":570},{"id":570,"name":"Throttle","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/decorators/src/Throttle.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Throttle.ts#L7"}],"signatures":[{"id":571,"name":"Throttle","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"A method decorator that throttles the execution of a class method to\\nonly fire once within every delay timeframe (in milliseconds)."}]},"sources":[{"fileName":"packages/decorators/src/Throttle.ts","line":7,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/Throttle.ts#L7"}],"parameters":[{"id":572,"name":"delay","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.decorators.legacy.d.ts","qualifiedName":"MethodDecorator"},"name":"MethodDecorator","package":"typescript"}}],"permalink":"/api/decorators/function/Throttle","previousId":547,"nextId":565}],"groups":[{"title":"Functions","children":[534,536,539,547,570]},{"title":"Interfaces","children":[565]},{"title":"Type Aliases","children":[560,556,551]}],"sources":[{"fileName":"packages/decorators/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/decorators/src/index.ts#L1"}],"permalink":"/api/decorators"},"urlSlug":"decorators"}],"packageName":"@boost/decorators","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":4,"name":"@boost/event","variant":"declaration","kind":2,"flags":{},"children":[{"id":573,"name":"BailEvent","variant":"declaration","kind":128,"flags":{},"children":[{"id":574,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":575,"name":"new BailEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":576,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":577,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":578,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":573,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}],"name":"BailEvent","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":618,"name":"BaseEvent.constructor"}}],"inheritedFrom":{"type":"reference","target":617,"name":"BaseEvent.constructor"}},{"id":583,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true},{"type":"literal","value":"*"}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":623,"name":"BaseEvent.listeners"}},{"id":584,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":624,"name":"BaseEvent.name"}},{"id":585,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":586,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":587,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":626,"name":"BaseEvent.clearListeners"}}],"inheritedFrom":{"type":"reference","target":625,"name":"BaseEvent.clearListeners"}},{"id":579,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BailEvent.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BailEvent.ts#L14"}],"signatures":[{"id":580,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Synchronously execute listeners with the defined arguments.\\nIf a listener returns "},{"kind":"code","text":"`false`"},{"kind":"text","text":", the loop with be aborted early,\\nand the emitter will return "},{"kind":"code","text":"`true`"},{"kind":"text","text":" (for bailed)."}]},"sources":[{"fileName":"packages/event/src/BailEvent.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BailEvent.ts#L14"}],"parameters":[{"id":581,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true}},{"id":582,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"boolean"},"overwrites":{"type":"reference","target":655,"name":"BaseEvent.emit"}}],"overwrites":{"type":"reference","target":654,"name":"BaseEvent.emit"}},{"id":588,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":589,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":590,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"},"inheritedFrom":{"type":"reference","target":629,"name":"BaseEvent.getListeners"}}],"inheritedFrom":{"type":"reference","target":628,"name":"BaseEvent.getListeners"}},{"id":591,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":592,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true},{"type":"literal","value":"*"}]}},"inheritedFrom":{"type":"reference","target":632,"name":"BaseEvent.getScopes"}}],"inheritedFrom":{"type":"reference","target":631,"name":"BaseEvent.getScopes"}},{"id":593,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":594,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":595,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}},{"id":596,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":634,"name":"BaseEvent.listen"}}],"inheritedFrom":{"type":"reference","target":633,"name":"BaseEvent.listen"}},{"id":597,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":598,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":599,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}},{"id":600,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":638,"name":"BaseEvent.once"}}],"inheritedFrom":{"type":"reference","target":637,"name":"BaseEvent.once"}},{"id":601,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":602,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":603,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]}],"name":"Listener","package":"@boost/event"}},{"id":604,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":642,"name":"BaseEvent.unlisten"}}],"inheritedFrom":{"type":"reference","target":641,"name":"BaseEvent.unlisten"}}],"groups":[{"title":"Constructors","children":[574]},{"title":"Properties","children":[583,584]},{"title":"Methods","children":[585,579,588,591,593,597,601]}],"sources":[{"fileName":"packages/event/src/BailEvent.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BailEvent.ts#L4"}],"typeParameters":[{"id":614,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":615,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedTypes":[{"type":"reference","target":616,"typeArguments":[{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"void"}]},{"type":"reference","target":576,"name":"Args","package":"@boost/event","qualifiedName":"BailEvent.Args","refersToTypeParameter":true},{"type":"reference","target":577,"name":"Scope","package":"@boost/event","qualifiedName":"BailEvent.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}],"permalink":"/api/event/class/BailEvent","nextId":616},{"id":616,"name":"BaseEvent","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":617,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":618,"name":"new BaseEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":619,"name":"Return","variant":"typeParam","kind":131072,"flags":{}},{"id":620,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":621,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":622,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":616,"typeArguments":[{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true},{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}}]},{"id":623,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true},{"type":"literal","value":"*"}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"..."},{"id":624,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"}},{"id":625,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":626,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":627,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":654,"name":"emit","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":123,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L123"}],"signatures":[{"id":655,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Emit the event by executing all scoped listeners with the defined arguments."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":123,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L123"}],"parameters":[{"id":656,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}},{"id":657,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"unknown"}}]},{"id":628,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":629,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":630,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}}]},{"id":631,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":632,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true},{"type":"literal","value":"*"}]}}}]},{"id":633,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":634,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":635,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}},{"id":636,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"}}]},{"id":637,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":638,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":639,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}},{"id":640,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"}}]},{"id":641,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":642,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":643,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":620,"name":"Args","package":"@boost/event","qualifiedName":"BaseEvent.Args","refersToTypeParameter":true},{"type":"reference","target":619,"name":"Return","package":"@boost/event","qualifiedName":"BaseEvent.Return","refersToTypeParameter":true}],"name":"Listener","package":"@boost/event"}},{"id":644,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":621,"name":"Scope","package":"@boost/event","qualifiedName":"BaseEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[617]},{"title":"Properties","children":[623,624]},{"title":"Methods","children":[625,654,628,631,633,637,641]}],"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":6,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L6"}],"typeParameters":[{"id":658,"name":"Return","variant":"typeParam","kind":131072,"flags":{}},{"id":659,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":660,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedBy":[{"type":"reference","target":573,"name":"BailEvent"},{"type":"reference","target":661,"name":"ConcurrentEvent"},{"type":"reference","target":706,"name":"Event"},{"type":"reference","target":790,"name":"WaterfallEvent"}],"permalink":"/api/event/class/BaseEvent","previousId":573,"nextId":661},{"id":661,"name":"ConcurrentEvent","variant":"declaration","kind":128,"flags":{},"children":[{"id":662,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":663,"name":"new ConcurrentEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":664,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":665,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":666,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":661,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}],"name":"ConcurrentEvent","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":618,"name":"BaseEvent.constructor"}}],"inheritedFrom":{"type":"reference","target":617,"name":"BaseEvent.constructor"}},{"id":671,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":623,"name":"BaseEvent.listeners"}},{"id":672,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":624,"name":"BaseEvent.name"}},{"id":673,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":674,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":675,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":626,"name":"BaseEvent.clearListeners"}}],"inheritedFrom":{"type":"reference","target":625,"name":"BaseEvent.clearListeners"}},{"id":667,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/ConcurrentEvent.ts","line":12,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/ConcurrentEvent.ts#L12"}],"signatures":[{"id":668,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Asynchronously execute listeners for with the defined arguments.\\nWill return a promise with an array of each listener result."}]},"sources":[{"fileName":"packages/event/src/ConcurrentEvent.ts","line":12,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/ConcurrentEvent.ts#L12"}],"parameters":[{"id":669,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true}},{"id":670,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":655,"name":"BaseEvent.emit"}}],"overwrites":{"type":"reference","target":654,"name":"BaseEvent.emit"}},{"id":676,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":677,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":678,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"},"inheritedFrom":{"type":"reference","target":629,"name":"BaseEvent.getListeners"}}],"inheritedFrom":{"type":"reference","target":628,"name":"BaseEvent.getListeners"}},{"id":679,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":680,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}]}},"inheritedFrom":{"type":"reference","target":632,"name":"BaseEvent.getScopes"}}],"inheritedFrom":{"type":"reference","target":631,"name":"BaseEvent.getScopes"}},{"id":681,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":682,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":683,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}},{"id":684,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":634,"name":"BaseEvent.listen"}}],"inheritedFrom":{"type":"reference","target":633,"name":"BaseEvent.listen"}},{"id":685,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":686,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":687,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}},{"id":688,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":638,"name":"BaseEvent.once"}}],"inheritedFrom":{"type":"reference","target":637,"name":"BaseEvent.once"}},{"id":689,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":690,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":691,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}],"name":"Listener","package":"@boost/event"}},{"id":692,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":642,"name":"BaseEvent.unlisten"}}],"inheritedFrom":{"type":"reference","target":641,"name":"BaseEvent.unlisten"}}],"groups":[{"title":"Constructors","children":[662]},{"title":"Properties","children":[671,672]},{"title":"Methods","children":[673,667,676,679,681,685,689]}],"sources":[{"fileName":"packages/event/src/ConcurrentEvent.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/ConcurrentEvent.ts#L4"}],"typeParameters":[{"id":702,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":703,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedTypes":[{"type":"reference","target":616,"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"},{"type":"reference","target":664,"name":"Args","package":"@boost/event","qualifiedName":"ConcurrentEvent.Args","refersToTypeParameter":true},{"type":"reference","target":665,"name":"Scope","package":"@boost/event","qualifiedName":"ConcurrentEvent.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}],"permalink":"/api/event/class/ConcurrentEvent","previousId":616,"nextId":706},{"id":706,"name":"Event","variant":"declaration","kind":128,"flags":{},"children":[{"id":707,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":708,"name":"new Event","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":709,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":710,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":711,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":706,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}],"name":"Event","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":618,"name":"BaseEvent.constructor"}}],"inheritedFrom":{"type":"reference","target":617,"name":"BaseEvent.constructor"}},{"id":716,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":623,"name":"BaseEvent.listeners"}},{"id":717,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":624,"name":"BaseEvent.name"}},{"id":718,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":719,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":720,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":626,"name":"BaseEvent.clearListeners"}}],"inheritedFrom":{"type":"reference","target":625,"name":"BaseEvent.clearListeners"}},{"id":712,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/Event.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/Event.ts#L11"}],"signatures":[{"id":713,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Synchronously execute listeners with the defined arguments."}]},"sources":[{"fileName":"packages/event/src/Event.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/Event.ts#L11"}],"parameters":[{"id":714,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true}},{"id":715,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","target":655,"name":"BaseEvent.emit"}}],"overwrites":{"type":"reference","target":654,"name":"BaseEvent.emit"}},{"id":721,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":722,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":723,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}],"name":"Set","package":"typescript"},"inheritedFrom":{"type":"reference","target":629,"name":"BaseEvent.getListeners"}}],"inheritedFrom":{"type":"reference","target":628,"name":"BaseEvent.getListeners"}},{"id":724,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":725,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}]}},"inheritedFrom":{"type":"reference","target":632,"name":"BaseEvent.getScopes"}}],"inheritedFrom":{"type":"reference","target":631,"name":"BaseEvent.getScopes"}},{"id":726,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":727,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":728,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}},{"id":729,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":634,"name":"BaseEvent.listen"}}],"inheritedFrom":{"type":"reference","target":633,"name":"BaseEvent.listen"}},{"id":730,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":731,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":732,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}},{"id":733,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":638,"name":"BaseEvent.once"}}],"inheritedFrom":{"type":"reference","target":637,"name":"BaseEvent.once"}},{"id":734,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":735,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":736,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":755,"typeArguments":[{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"intrinsic","name":"void"}],"name":"Listener","package":"@boost/event"}},{"id":737,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":642,"name":"BaseEvent.unlisten"}}],"inheritedFrom":{"type":"reference","target":641,"name":"BaseEvent.unlisten"}}],"groups":[{"title":"Constructors","children":[707]},{"title":"Properties","children":[716,717]},{"title":"Methods","children":[718,712,721,724,726,730,734]}],"sources":[{"fileName":"packages/event/src/Event.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/Event.ts#L3"}],"typeParameters":[{"id":747,"name":"Args","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":748,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedTypes":[{"type":"reference","target":616,"typeArguments":[{"type":"intrinsic","name":"void"},{"type":"reference","target":709,"name":"Args","package":"@boost/event","qualifiedName":"Event.Args","refersToTypeParameter":true},{"type":"reference","target":710,"name":"Scope","package":"@boost/event","qualifiedName":"Event.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}],"permalink":"/api/event/class/Event","previousId":661,"nextId":790},{"id":790,"name":"WaterfallEvent","variant":"declaration","kind":128,"flags":{},"children":[{"id":791,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"signatures":[{"id":792,"name":"new WaterfallEvent","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L11"}],"typeParameter":[{"id":793,"name":"Arg","variant":"typeParam","kind":131072,"flags":{}},{"id":794,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"parameters":[{"id":795,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":790,"typeArguments":[{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true},{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}],"name":"WaterfallEvent","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":618,"name":"BaseEvent.constructor"}}],"inheritedFrom":{"type":"reference","target":617,"name":"BaseEvent.constructor"}},{"id":800,"name":"listeners","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L7"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Map"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}]},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reflection","declaration":{"id":801,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":802,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":803,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}],"name":"Set","package":"typescript"}],"name":"Map","package":"typescript"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":623,"name":"BaseEvent.listeners"}},{"id":804,"name":"name","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L9"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":624,"name":"BaseEvent.name"}},{"id":805,"name":"clearListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"signatures":[{"id":806,"name":"clearListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove all listeners from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L22"}],"parameters":[{"id":807,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":626,"name":"BaseEvent.clearListeners"}}],"inheritedFrom":{"type":"reference","target":625,"name":"BaseEvent.clearListeners"}},{"id":796,"name":"emit","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/WaterfallEvent.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/WaterfallEvent.ts#L13"}],"signatures":[{"id":797,"name":"emit","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Synchronously execute listeners with the defined argument value.\\nThe return value of each listener will be passed as an argument to the next listener."}]},"sources":[{"fileName":"packages/event/src/WaterfallEvent.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/WaterfallEvent.ts#L13"}],"parameters":[{"id":798,"name":"arg","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}},{"id":799,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true},"overwrites":{"type":"reference","target":655,"name":"BaseEvent.emit"}}],"overwrites":{"type":"reference","target":654,"name":"BaseEvent.emit"}},{"id":808,"name":"getListeners","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"signatures":[{"id":809,"name":"getListeners","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a set of listeners for a specific event scope."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":35,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L35"}],"parameters":[{"id":810,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es2015.collection.d.ts","qualifiedName":"Set"},"typeArguments":[{"type":"reflection","declaration":{"id":811,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":812,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":813,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}],"name":"Set","package":"typescript"},"inheritedFrom":{"type":"reference","target":629,"name":"BaseEvent.getListeners"}}],"inheritedFrom":{"type":"reference","target":628,"name":"BaseEvent.getListeners"}},{"id":814,"name":"getScopes","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"signatures":[{"id":815,"name":"getScopes","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of all scopes with listeners."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L48"}],"type":{"type":"array","elementType":{"type":"union","types":[{"type":"literal","value":"*"},{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}]}},"inheritedFrom":{"type":"reference","target":632,"name":"BaseEvent.getScopes"}}],"inheritedFrom":{"type":"reference","target":631,"name":"BaseEvent.getScopes"}},{"id":816,"name":"listen","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"signatures":[{"id":817,"name":"listen","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L55"}],"parameters":[{"id":818,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":819,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":820,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":821,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}},{"id":822,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":634,"name":"BaseEvent.listen"}}],"inheritedFrom":{"type":"reference","target":633,"name":"BaseEvent.listen"}},{"id":823,"name":"once","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"signatures":[{"id":824,"name":"once","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a listener to the event that only triggers once."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L70"}],"parameters":[{"id":825,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":826,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":827,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":828,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}},{"id":829,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"reference","target":786,"name":"Unlistener","package":"@boost/event"},"inheritedFrom":{"type":"reference","target":638,"name":"BaseEvent.once"}}],"inheritedFrom":{"type":"reference","target":637,"name":"BaseEvent.once"}},{"id":830,"name":"unlisten","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"signatures":[{"id":831,"name":"unlisten","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Remove a listener from the event."}]},"sources":[{"fileName":"packages/event/src/BaseEvent.ts","line":84,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/BaseEvent.ts#L84"}],"parameters":[{"id":832,"name":"listener","variant":"param","kind":32768,"flags":{},"type":{"type":"reflection","declaration":{"id":833,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":834,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"parameters":[{"id":835,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}],"type":{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}}]}}},{"id":836,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":642,"name":"BaseEvent.unlisten"}}],"inheritedFrom":{"type":"reference","target":641,"name":"BaseEvent.unlisten"}}],"groups":[{"title":"Constructors","children":[791]},{"title":"Properties","children":[800,804]},{"title":"Methods","children":[805,796,808,814,816,823,830]}],"sources":[{"fileName":"packages/event/src/WaterfallEvent.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/WaterfallEvent.ts#L4"}],"typeParameters":[{"id":846,"name":"Arg","variant":"typeParam","kind":131072,"flags":{}},{"id":847,"name":"Scope","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"string"},"default":{"type":"intrinsic","name":"string"}}],"extendedTypes":[{"type":"reference","target":616,"typeArguments":[{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true},{"type":"tuple","elements":[{"type":"reference","target":793,"name":"Arg","package":"@boost/event","qualifiedName":"WaterfallEvent.Arg","refersToTypeParameter":true}]},{"type":"reference","target":794,"name":"Scope","package":"@boost/event","qualifiedName":"WaterfallEvent.Scope","refersToTypeParameter":true}],"name":"BaseEvent","package":"@boost/event"}],"permalink":"/api/event/class/WaterfallEvent","previousId":706,"nextId":749},{"id":749,"name":"EventErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/event/src/EventError.ts","line":9,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/EventError.ts#L9"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/event/src/EventError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/event","preferValues":true}}},"permalink":"/api/event#EventErrorCode","previousId":790,"nextId":755},{"id":755,"name":"Listener","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":1,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L1"}],"typeParameters":[{"id":784,"name":"A","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":785,"name":"R","variant":"typeParam","kind":131072,"flags":{}}],"type":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"},{"type":"inferred","name":"A2"},{"type":"inferred","name":"A3"},{"type":"inferred","name":"A4"},{"type":"inferred","name":"A5"}]},"trueType":{"type":"reflection","declaration":{"id":756,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":8,"character":3,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L8"}],"signatures":[{"id":757,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":758,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}},{"id":759,"name":"a2","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A2"},"name":"A2","package":"@boost/event","refersToTypeParameter":true}},{"id":760,"name":"a3","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A3"},"name":"A3","package":"@boost/event","refersToTypeParameter":true}},{"id":761,"name":"a4","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A4"},"name":"A4","package":"@boost/event","refersToTypeParameter":true}},{"id":762,"name":"a5","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A5"},"name":"A5","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"},{"type":"inferred","name":"A2"},{"type":"inferred","name":"A3"},{"type":"inferred","name":"A4"}]},"trueType":{"type":"reflection","declaration":{"id":763,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":10,"character":4,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L10"}],"signatures":[{"id":764,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":765,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}},{"id":766,"name":"a2","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A2"},"name":"A2","package":"@boost/event","refersToTypeParameter":true}},{"id":767,"name":"a3","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A3"},"name":"A3","package":"@boost/event","refersToTypeParameter":true}},{"id":768,"name":"a4","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A4"},"name":"A4","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"},{"type":"inferred","name":"A2"},{"type":"inferred","name":"A3"}]},"trueType":{"type":"reflection","declaration":{"id":769,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":12,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L12"}],"signatures":[{"id":770,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":771,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}},{"id":772,"name":"a2","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A2"},"name":"A2","package":"@boost/event","refersToTypeParameter":true}},{"id":773,"name":"a3","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A3"},"name":"A3","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"},{"type":"inferred","name":"A2"}]},"trueType":{"type":"reflection","declaration":{"id":774,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":14,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L14"}],"signatures":[{"id":775,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":776,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}},{"id":777,"name":"a2","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A2"},"name":"A2","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"tuple","elements":[{"type":"inferred","name":"A1"}]},"trueType":{"type":"reflection","declaration":{"id":778,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L16"}],"signatures":[{"id":779,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":780,"name":"a1","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/types.ts","qualifiedName":"A1"},"name":"A1","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"conditional","checkType":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true},"extendsType":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},"trueType":{"type":"reflection","declaration":{"id":781,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":18,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L18"}],"signatures":[{"id":782,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":783,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"reference","target":784,"name":"A","package":"@boost/event","refersToTypeParameter":true}}],"type":{"type":"reference","target":785,"name":"R","package":"@boost/event","refersToTypeParameter":true}}]}},"falseType":{"type":"intrinsic","name":"never"}}}}}}},"permalink":"/api/event#Listener","previousId":749,"nextId":786},{"id":786,"name":"Unlistener","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":21,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L21"}],"type":{"type":"reflection","declaration":{"id":787,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":21,"character":25,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L21"}],"signatures":[{"id":788,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"void"}}]}},"permalink":"/api/event#Unlistener","previousId":755,"nextId":789},{"id":789,"name":"WildstarScope","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/event/src/types.ts","line":23,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/types.ts#L23"}],"type":{"type":"literal","value":"*"},"permalink":"/api/event#WildstarScope","previousId":786,"nextId":705},{"id":705,"name":"EVENT_NAME_PATTERN","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/event/src/constants.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/constants.ts#L3"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/event#EVENT_NAME_PATTERN","previousId":789,"nextId":750},{"id":750,"name":"EventError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/event/src/EventError.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/EventError.ts#L11"}],"type":{"type":"reflection","declaration":{"id":751,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":752,"name":"new EventError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":753,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"LISTENER_INVALID"},{"type":"literal","value":"NAME_INVALID"}]}},{"id":754,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"LISTENER_INVALID"},{"type":"literal","value":"NAME_INVALID"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/event#EventError","previousId":705,"nextId":704},{"id":704,"name":"WILDCARD_SCOPE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/event/src/constants.ts","line":1,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/constants.ts#L1"}],"type":{"type":"literal","value":"*"},"defaultValue":"\'*\'","permalink":"/api/event#WILDCARD_SCOPE","previousId":750}],"groups":[{"title":"Classes","children":[573,616,661,706,790]},{"title":"Type Aliases","children":[749,755,786,789]},{"title":"Variables","children":[705,750,704]}],"sources":[{"fileName":"packages/event/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/event/src/index.ts#L1"}],"permalink":"/api/event"},"urlSlug":"event"}],"packageName":"@boost/event","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":95,"name":"@boost/log","variant":"declaration","kind":2,"flags":{},"children":[{"id":3210,"name":"formats","variant":"declaration","kind":4,"flags":{},"children":[{"id":3211,"name":"console","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/formats.ts","line":18,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L18"}],"signatures":[{"id":3212,"name":"console","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the item as if it\'s being logged to "},{"kind":"code","text":"`console`"},{"kind":"text","text":".\\n_Only_ inclues the label and message."}]},"sources":[{"fileName":"packages/log/src/formats.ts","line":18,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L18"}],"parameters":[{"id":3213,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/log/namespace/formats#console"},{"id":3214,"name":"debug","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/formats.ts","line":32,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L32"}],"signatures":[{"id":3215,"name":"debug","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the item into a human-readable message with all item fields included.\\nThis is the default format for most transports."}]},"sources":[{"fileName":"packages/log/src/formats.ts","line":32,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L32"}],"parameters":[{"id":3216,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/log/namespace/formats#debug"},{"id":3217,"name":"json","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/formats.ts","line":46,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L46"}],"signatures":[{"id":3218,"name":"json","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the entire item into JSON."}]},"sources":[{"fileName":"packages/log/src/formats.ts","line":46,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L46"}],"parameters":[{"id":3219,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/log/namespace/formats#json"},{"id":3220,"name":"message","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/formats.ts","line":53,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L53"}],"signatures":[{"id":3221,"name":"message","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the item using _only_ the message."}]},"sources":[{"fileName":"packages/log/src/formats.ts","line":53,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L53"}],"parameters":[{"id":3222,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/log/namespace/formats#message"}],"groups":[{"title":"Functions","children":[3211,3214,3217,3220]}],"sources":[{"fileName":"packages/log/src/formats.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/formats.ts#L1"}],"permalink":"/api/log/namespace/formats","previousId":3510,"nextId":3515},{"id":3279,"name":"ConsoleTransport","variant":"declaration","kind":128,"flags":{},"children":[{"id":3280,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L7"}],"signatures":[{"id":3281,"name":"new ConsoleTransport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L7"}],"parameters":[{"id":3282,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}],"type":{"type":"reference","target":3279,"name":"ConsoleTransport","package":"@boost/log"},"overwrites":{"type":"reference","target":3257,"name":"Transport.constructor"}}],"overwrites":{"type":"reference","target":3256,"name":"Transport.constructor"}},{"id":3287,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","inheritedFrom":{"type":"reference","target":3260,"name":"Transport.levels"}},{"id":3294,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3271,"name":"Transport.options"}},{"id":3288,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L20"}],"signatures":[{"id":3289,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L20"}],"parameters":[{"id":3290,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"inheritedFrom":{"type":"reference","target":3262,"name":"Transport.blueprint"}}],"inheritedFrom":{"type":"reference","target":3261,"name":"Transport.blueprint"}},{"id":3295,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3296,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3297,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3298,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3299,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3300,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3273,"name":"Transport.configure"}}],"inheritedFrom":{"type":"reference","target":3272,"name":"Transport.configure"}},{"id":3291,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3292,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3293,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3265,"name":"Transport.format"}}],"inheritedFrom":{"type":"reference","target":3264,"name":"Transport.format"}},{"id":3283,"name":"write","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L15"}],"signatures":[{"id":3284,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write the formatted message according to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L15"}],"parameters":[{"id":3285,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3286,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","target":3268,"name":"Transport.write"}}],"overwrites":{"type":"reference","target":3267,"name":"Transport.write"}}],"groups":[{"title":"Constructors","children":[3280]},{"title":"Properties","children":[3287,3294]},{"title":"Methods","children":[3288,3295,3291,3283]}],"sources":[{"fileName":"packages/log/src/transports/ConsoleTransport.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/ConsoleTransport.ts#L6"}],"extendedTypes":[{"type":"reference","target":3255,"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Transport","package":"@boost/log"}],"permalink":"/api/log/class/ConsoleTransport","nextId":3308},{"id":3308,"name":"FileTransport","variant":"declaration","kind":128,"flags":{},"children":[{"id":3309,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L36"}],"signatures":[{"id":3310,"name":"new FileTransport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L36"}],"typeParameter":[{"id":3311,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"},"default":{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"}}],"parameters":[{"id":3312,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":3308,"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"FileTransport","package":"@boost/log"},"overwrites":{"type":"reference","target":3257,"name":"Transport.constructor"}}],"overwrites":{"type":"reference","target":3256,"name":"Transport.constructor"}},{"id":3347,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","inheritedFrom":{"type":"reference","target":3260,"name":"Transport.levels"}},{"id":3351,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3271,"name":"Transport.options"}},{"id":3313,"name":"path","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":24,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L24"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"}},{"id":3314,"name":"stream","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L26"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeJS.WritableStream"},"name":"WritableStream","package":"@types/node","qualifiedName":"__global.NodeJS.WritableStream"}},{"id":3319,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":44,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L44"}],"signatures":[{"id":3320,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":44,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L44"}],"parameters":[{"id":3321,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":3262,"name":"Transport.blueprint"}}],"overwrites":{"type":"reference","target":3261,"name":"Transport.blueprint"}},{"id":3322,"name":"close","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"signatures":[{"id":3323,"name":"close","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Close the file stream and trigger the callback when finished."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"parameters":[{"id":3324,"name":"commit","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":3325,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"signatures":[{"id":3326,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"}}]},{"id":3352,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3353,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3354,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3355,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3356,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3357,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3273,"name":"Transport.configure"}}],"inheritedFrom":{"type":"reference","target":3272,"name":"Transport.configure"}},{"id":3348,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3349,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3350,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3265,"name":"Transport.format"}}],"inheritedFrom":{"type":"reference","target":3264,"name":"Transport.format"}},{"id":3327,"name":"open","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L74"}],"signatures":[{"id":3328,"name":"open","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Open the file stream for writing."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L74"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeJS.WritableStream"},"name":"WritableStream","package":"@types/node","qualifiedName":"__global.NodeJS.WritableStream"}}]},{"id":3329,"name":"write","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L98"}],"signatures":[{"id":3330,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the file stream, and rotate files once written if necessary."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L98"}],"parameters":[{"id":3331,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","target":3268,"name":"Transport.write"}}],"overwrites":{"type":"reference","target":3267,"name":"Transport.write"}}],"groups":[{"title":"Constructors","children":[3309]},{"title":"Properties","children":[3347,3351,3313,3314]},{"title":"Methods","children":[3319,3322,3352,3348,3327,3329]}],"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":21,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L21"}],"typeParameters":[{"id":3358,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"},"default":{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"}}],"extendedTypes":[{"type":"reference","target":3255,"typeArguments":[{"type":"reference","target":3311,"name":"Options","package":"@boost/log","qualifiedName":"FileTransport.Options","refersToTypeParameter":true}],"name":"Transport","package":"@boost/log"}],"extendedBy":[{"type":"reference","target":3367,"name":"RotatingFileTransport"}],"permalink":"/api/log/class/FileTransport","previousId":3279,"nextId":3229},{"id":3229,"name":"Logger","variant":"declaration","kind":128,"flags":{},"children":[{"id":3230,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L15"}],"signatures":[{"id":3231,"name":"new Logger","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L15"}],"parameters":[{"id":3232,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}}],"type":{"type":"reference","target":3229,"name":"Logger","package":"@boost/log"},"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":3248,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":3234,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L29"}],"signatures":[{"id":3235,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L29"}],"parameters":[{"id":3236,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":3249,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3250,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3251,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3252,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3253,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3254,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":3237,"name":"disable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L45"}],"signatures":[{"id":3238,"name":"disable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/Logger.ts","line":45,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L45"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":3239,"name":"enable","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L53"}],"signatures":[{"id":3240,"name":"enable","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/Logger.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L53"}],"type":{"type":"intrinsic","name":"void"}}]},{"id":3241,"name":"isAllowed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L58"}],"signatures":[{"id":3242,"name":"isAllowed","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L58"}],"parameters":[{"id":3243,"name":"level","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},{"id":3244,"name":"maxLevel","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":3245,"name":"log","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L76"}],"signatures":[{"id":3246,"name":"log","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Logger.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L76"}],"parameters":[{"id":3247,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3459,"name":"LogOptions","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"void"}}]}],"groups":[{"title":"Constructors","children":[3230]},{"title":"Properties","children":[3248]},{"title":"Methods","children":[3234,3249,3237,3239,3241,3245]}],"sources":[{"fileName":"packages/log/src/Logger.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Logger.ts#L12"}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}],"name":"Contract","package":"@boost/common"}],"permalink":"/api/log/class/Logger","previousId":3308,"nextId":3367},{"id":3367,"name":"RotatingFileTransport","variant":"declaration","kind":128,"flags":{},"children":[{"id":3368,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L36"}],"signatures":[{"id":3369,"name":"new RotatingFileTransport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":36,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L36"}],"parameters":[{"id":3370,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}}],"type":{"type":"reference","target":3367,"name":"RotatingFileTransport","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3310,"name":"FileTransport.constructor"}}],"inheritedFrom":{"type":"reference","target":3309,"name":"FileTransport.constructor"}},{"id":3409,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","inheritedFrom":{"type":"reference","target":3347,"name":"FileTransport.levels"}},{"id":3413,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3351,"name":"FileTransport.options"}},{"id":3384,"name":"path","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":24,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L24"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/Path.ts","qualifiedName":"Path"},"name":"Path","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":3313,"name":"FileTransport.path"}},{"id":3385,"name":"stream","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L26"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeJS.WritableStream"},"name":"WritableStream","package":"@types/node","qualifiedName":"__global.NodeJS.WritableStream"},"inheritedFrom":{"type":"reference","target":3314,"name":"FileTransport.stream"}},{"id":3372,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":15,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L15"}],"signatures":[{"id":3373,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":15,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L15"}],"parameters":[{"id":3374,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":3320,"name":"FileTransport.blueprint"}}],"overwrites":{"type":"reference","target":3319,"name":"FileTransport.blueprint"}},{"id":3390,"name":"close","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"signatures":[{"id":3391,"name":"close","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Close the file stream and trigger the callback when finished."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"parameters":[{"id":3392,"name":"commit","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":3393,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"signatures":[{"id":3394,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L58"}],"type":{"type":"intrinsic","name":"void"}}]}}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","target":3323,"name":"FileTransport.close"}}],"inheritedFrom":{"type":"reference","target":3322,"name":"FileTransport.close"}},{"id":3414,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3415,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3416,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3417,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3418,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3419,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3353,"name":"FileTransport.configure"}}],"inheritedFrom":{"type":"reference","target":3352,"name":"FileTransport.configure"}},{"id":3410,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3411,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3412,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3349,"name":"FileTransport.format"}}],"inheritedFrom":{"type":"reference","target":3348,"name":"FileTransport.format"}},{"id":3375,"name":"formatTimestamp","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L27"}],"signatures":[{"id":3376,"name":"formatTimestamp","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format a "},{"kind":"code","text":"`Date`"},{"kind":"text","text":" object into a format used within the log file name."}]},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L27"}],"parameters":[{"id":3377,"name":"ms","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}]},{"id":3395,"name":"open","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L74"}],"signatures":[{"id":3396,"name":"open","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Open the file stream for writing."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L74"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeJS.WritableStream"},"name":"WritableStream","package":"@types/node","qualifiedName":"__global.NodeJS.WritableStream"},"inheritedFrom":{"type":"reference","target":3328,"name":"FileTransport.open"}}],"inheritedFrom":{"type":"reference","target":3327,"name":"FileTransport.open"}},{"id":3397,"name":"write","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L98"}],"signatures":[{"id":3398,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the file stream, and rotate files once written if necessary."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L98"}],"parameters":[{"id":3399,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"},"inheritedFrom":{"type":"reference","target":3330,"name":"FileTransport.write"}}],"inheritedFrom":{"type":"reference","target":3329,"name":"FileTransport.write"}}],"groups":[{"title":"Constructors","children":[3368]},{"title":"Properties","children":[3409,3413,3384,3385]},{"title":"Methods","children":[3372,3390,3414,3410,3375,3395,3397]}],"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L12"}],"extendedTypes":[{"type":"reference","target":3308,"typeArguments":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions","package":"@boost/log"}],"name":"FileTransport","package":"@boost/log"}],"permalink":"/api/log/class/RotatingFileTransport","previousId":3229,"nextId":3425},{"id":3425,"name":"StreamTransport","variant":"declaration","kind":128,"flags":{},"children":[{"id":3426,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L13"}],"signatures":[{"id":3427,"name":"new StreamTransport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L13"}],"parameters":[{"id":3428,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}}],"type":{"type":"reference","target":3425,"name":"StreamTransport","package":"@boost/log"},"overwrites":{"type":"reference","target":3257,"name":"Transport.constructor"}}],"overwrites":{"type":"reference","target":3256,"name":"Transport.constructor"}},{"id":3436,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","inheritedFrom":{"type":"reference","target":3260,"name":"Transport.levels"}},{"id":3440,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3271,"name":"Transport.options"}},{"id":3430,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L19"}],"signatures":[{"id":3431,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L19"}],"parameters":[{"id":3432,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":3262,"name":"Transport.blueprint"}}],"overwrites":{"type":"reference","target":3261,"name":"Transport.blueprint"}},{"id":3441,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3442,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3443,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3444,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3445,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3446,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":3273,"name":"Transport.configure"}}],"inheritedFrom":{"type":"reference","target":3272,"name":"Transport.configure"}},{"id":3437,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3438,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3439,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3265,"name":"Transport.format"}}],"inheritedFrom":{"type":"reference","target":3264,"name":"Transport.format"}},{"id":3433,"name":"write","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L33"}],"signatures":[{"id":3434,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the configured stream."}]},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L33"}],"parameters":[{"id":3435,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"},"overwrites":{"type":"reference","target":3268,"name":"Transport.write"}}],"overwrites":{"type":"reference","target":3267,"name":"Transport.write"}}],"groups":[{"title":"Constructors","children":[3426]},{"title":"Properties","children":[3436,3440]},{"title":"Methods","children":[3430,3441,3437,3433]}],"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L10"}],"extendedTypes":[{"type":"reference","target":3255,"typeArguments":[{"type":"reference","target":3420,"name":"StreamTransportOptions","package":"@boost/log"}],"name":"Transport","package":"@boost/log"}],"permalink":"/api/log/class/StreamTransport","previousId":3367,"nextId":3255},{"id":3255,"name":"Transport","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":3256,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L14"}],"signatures":[{"id":3257,"name":"new Transport","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L14"}],"typeParameter":[{"id":3258,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}}],"parameters":[{"id":3259,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":3255,"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Transport","package":"@boost/log"},"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":3260,"name":"levels","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/log/src/Transport.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L12"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"[]","implementationOf":{"type":"reference","target":3520,"name":"Transportable.levels"}},{"id":3271,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":3261,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L20"}],"signatures":[{"id":3262,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L20"}],"parameters":[{"id":3263,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":3272,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":3273,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":3274,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":3275,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":3276,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":3277,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":3264,"name":"format","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"signatures":[{"id":3265,"name":"format","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format the log item into a message string, and append a trailing newline if missing."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L33"}],"parameters":[{"id":3266,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":-1,"name":"Transportable.format"}}],"implementationOf":{"type":"reference","target":3521,"name":"Transportable.format"}},{"id":3267,"name":"write","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L48"}],"signatures":[{"id":3268,"name":"write","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write the formatted message according to the transport."}]},"sources":[{"fileName":"packages/log/src/Transport.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L48"}],"parameters":[{"id":3269,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3270,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}]},"implementationOf":{"type":"reference","target":3522,"name":"Transportable.write"}}],"implementationOf":{"type":"reference","target":3522,"name":"Transportable.write"}}],"groups":[{"title":"Constructors","children":[3256]},{"title":"Properties","children":[3260,3271]},{"title":"Methods","children":[3261,3272,3264,3267]}],"sources":[{"fileName":"packages/log/src/Transport.ts","line":8,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/Transport.ts#L8"}],"typeParameters":[{"id":3278,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":3258,"name":"Options","package":"@boost/log","qualifiedName":"Transport.Options","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}],"extendedBy":[{"type":"reference","target":3279,"name":"ConsoleTransport"},{"type":"reference","target":3308,"name":"FileTransport"},{"type":"reference","target":3425,"name":"StreamTransport"}],"implementedTypes":[{"type":"reference","target":3519,"name":"Transportable","package":"@boost/log"}],"permalink":"/api/log/class/Transport","previousId":3425,"nextId":3226},{"id":3301,"name":"FileTransportOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3305,"name":"eol","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"End of line character to append to a message. Defaults to "},{"kind":"code","text":"`os.EOL`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3528,"name":"TransportOptions.eol"}},{"id":3306,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to format a log item into a message string. Default is transport dependent."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":97,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L97"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3529,"name":"TransportOptions.format"}},{"id":3302,"name":"gzip","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Apply gzip compression to the write stream."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L11"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":3307,"name":"levels","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of log levels to only write messages for."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L99"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"inheritedFrom":{"type":"reference","target":3530,"name":"TransportOptions.levels"}},{"id":3303,"name":"maxSize","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Maximum file size before rotating file.\\nWill create a backup and truncate the current file. Defaults to 10mb."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L16"}],"type":{"type":"intrinsic","name":"number"}},{"id":3304,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute file system path for the intended log file."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}],"groups":[{"title":"Properties","children":[3305,3306,3302,3307,3303,3304]}],"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":9,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L9"}],"extendedTypes":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"extendedBy":[{"type":"reference","target":3359,"name":"RotatingFileTransportOptions"}],"permalink":"/api/log/interface/FileTransportOptions","previousId":3226,"nextId":3450},{"id":3450,"name":"LogItem","variant":"declaration","kind":256,"flags":{},"children":[{"id":3451,"name":"host","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The name of the host machine."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L9"}],"type":{"type":"intrinsic","name":"string"}},{"id":3452,"name":"label","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The log level as a localized or customized label."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L11"}],"type":{"type":"intrinsic","name":"string"}},{"id":3453,"name":"level","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The log level as a string."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L13"}],"type":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},{"id":3454,"name":"message","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The log message with interpolated arguments applied."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"string"}},{"id":3455,"name":"metadata","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Additional data to include with a log item."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L17"}],"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}},{"id":3456,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Name of the logger."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L19"}],"type":{"type":"intrinsic","name":"string"}},{"id":3457,"name":"pid","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current process ID."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L21"}],"type":{"type":"intrinsic","name":"number"}},{"id":3458,"name":"time","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Timestamp of the log, native to the host machine."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L23"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Date"},"name":"Date","package":"typescript"}}],"groups":[{"title":"Properties","children":[3451,3452,3453,3454,3455,3456,3457,3458]}],"sources":[{"fileName":"packages/log/src/types.ts","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L7"}],"permalink":"/api/log/interface/LogItem","previousId":3301,"nextId":3459},{"id":3459,"name":"LogOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3460,"name":"args","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Values to interpolate into the message string."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L28"}],"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}},{"id":3461,"name":"level","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Level to log as."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L30"}],"type":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},{"id":3462,"name":"message","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Message to log to the transports."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L32"}],"type":{"type":"intrinsic","name":"string"}},{"id":3463,"name":"metadata","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Metadata to include in the message item/string."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L34"}],"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}}],"groups":[{"title":"Properties","children":[3460,3461,3462,3463]}],"sources":[{"fileName":"packages/log/src/types.ts","line":26,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L26"}],"permalink":"/api/log/interface/LogOptions","previousId":3450,"nextId":3472},{"id":3472,"name":"Loggable","variant":"declaration","kind":256,"flags":{},"children":[{"id":3473,"name":"debug","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`debug`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":49,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L49"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3474,"name":"disable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"type":{"type":"reflection","declaration":{"id":3475,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"signatures":[{"id":3476,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3477,"name":"enable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"type":{"type":"reflection","declaration":{"id":3478,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"signatures":[{"id":3479,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"type":{"type":"intrinsic","name":"void"}}]}}},{"id":3480,"name":"error","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`error`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L55"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3482,"name":"info","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`info`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":59,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L59"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3481,"name":"log","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`log`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":57,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L57"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3483,"name":"trace","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`trace`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":61,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L61"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}},{"id":3484,"name":"warn","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`warn`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":63,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L63"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}}],"groups":[{"title":"Properties","children":[3473,3474,3477,3480,3482,3481,3483,3484]}],"sources":[{"fileName":"packages/log/src/types.ts","line":47,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L47"}],"extendedBy":[{"type":"reference","target":3485,"name":"LoggerFunction"}],"permalink":"/api/log/interface/Loggable","previousId":3459,"nextId":3464},{"id":3464,"name":"LoggableWriter","variant":"declaration","kind":256,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":37,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L37"}],"signatures":[{"id":3465,"name":"LoggableWriter","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters,\\nwhile also providing a metadata object to include with the log item."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":42,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L42"}],"parameters":[{"id":3466,"name":"metadata","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}},{"id":3467,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3468,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}},{"id":3469,"name":"LoggableWriter","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":44,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L44"}],"parameters":[{"id":3470,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3471,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}}],"extendedBy":[{"type":"reference","target":3485,"name":"LoggerFunction"}],"permalink":"/api/log/interface/LoggableWriter","previousId":3472,"nextId":3485},{"id":3485,"name":"LoggerFunction","variant":"declaration","kind":256,"flags":{},"children":[{"id":3486,"name":"debug","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`debug`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":49,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L49"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3473,"name":"Loggable.debug"}},{"id":3487,"name":"disable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"type":{"type":"reflection","declaration":{"id":3488,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"signatures":[{"id":3489,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Disable all logger messages from logging to the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L51"}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":3474,"name":"Loggable.disable"}},{"id":3490,"name":"enable","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"type":{"type":"reflection","declaration":{"id":3491,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"signatures":[{"id":3492,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Enable all logger messages to log the console."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":53,"character":9,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L53"}],"type":{"type":"intrinsic","name":"void"}}]}},"inheritedFrom":{"type":"reference","target":3477,"name":"Loggable.enable"}},{"id":3493,"name":"error","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`error`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":55,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L55"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3480,"name":"Loggable.error"}},{"id":3495,"name":"info","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`info`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":59,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L59"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3482,"name":"Loggable.info"}},{"id":3494,"name":"log","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`log`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":57,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L57"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3481,"name":"Loggable.log"}},{"id":3496,"name":"trace","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`trace`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":61,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L61"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3483,"name":"Loggable.trace"}},{"id":3497,"name":"warn","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message with the "},{"kind":"code","text":"`warn`"},{"kind":"text","text":" log level."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":63,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L63"}],"type":{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3484,"name":"Loggable.warn"}}],"groups":[{"title":"Properties","children":[3486,3487,3490,3493,3495,3494,3496,3497]}],"sources":[{"fileName":"packages/log/src/types.ts","line":66,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L66"}],"signatures":[{"id":3498,"name":"LoggerFunction","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters,\\nwhile also providing a metadata object to include with the log item."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":66,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L66"}],"parameters":[{"id":3499,"name":"metadata","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}},{"id":3500,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3501,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}},{"id":3502,"name":"LoggerFunction","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Log a message to the console and interpolate with the parameters."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":66,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L66"}],"parameters":[{"id":3503,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3504,"name":"params","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intrinsic","name":"void"}}],"extendedTypes":[{"type":"reference","target":3472,"name":"Loggable","package":"@boost/log"},{"type":"reference","target":3464,"name":"LoggableWriter","package":"@boost/log"}],"permalink":"/api/log/interface/LoggerFunction","previousId":3464,"nextId":3505},{"id":3505,"name":"LoggerOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3506,"name":"labels","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom labels to use for each log type."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":70,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L70"}],"type":{"type":"reference","target":3448,"name":"LogLevelLabels","package":"@boost/log"}},{"id":3507,"name":"metadata","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Metadata to include within each log item."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":72,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L72"}],"type":{"type":"reference","target":3449,"name":"LogMetadata","package":"@boost/log"}},{"id":3508,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique name for this logger."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":74,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L74"}],"type":{"type":"intrinsic","name":"string"}},{"id":3509,"name":"transports","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"List of transports to write messages to."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":76,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L76"}],"type":{"type":"array","elementType":{"type":"reference","target":3519,"name":"Transportable","package":"@boost/log"}}}],"groups":[{"title":"Properties","children":[3506,3507,3508,3509]}],"sources":[{"fileName":"packages/log/src/types.ts","line":68,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L68"}],"permalink":"/api/log/interface/LoggerOptions","previousId":3485,"nextId":3359},{"id":3359,"name":"RotatingFileTransportOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3364,"name":"eol","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"End of line character to append to a message. Defaults to "},{"kind":"code","text":"`os.EOL`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3305,"name":"FileTransportOptions.eol"}},{"id":3365,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to format a log item into a message string. Default is transport dependent."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":97,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L97"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3306,"name":"FileTransportOptions.format"}},{"id":3361,"name":"gzip","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Apply gzip compression to the write stream."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L11"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":3302,"name":"FileTransportOptions.gzip"}},{"id":3366,"name":"levels","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of log levels to only write messages for."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L99"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"inheritedFrom":{"type":"reference","target":3307,"name":"FileTransportOptions.levels"}},{"id":3362,"name":"maxSize","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Maximum file size before rotating file.\\nWill create a backup and truncate the current file. Defaults to 10mb."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L16"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":3303,"name":"FileTransportOptions.maxSize"}},{"id":3363,"name":"path","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Absolute file system path for the intended log file."}]},"sources":[{"fileName":"packages/log/src/transports/FileTransport.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/FileTransport.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},"inheritedFrom":{"type":"reference","target":3304,"name":"FileTransportOptions.path"}},{"id":3360,"name":"rotation","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Period in which to rotate files. Will append a timestamp to the rotated log file."}]},"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":9,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L9"}],"type":{"type":"reference","target":3531,"name":"Rotation","package":"@boost/log"}}],"groups":[{"title":"Properties","children":[3364,3365,3361,3366,3362,3363,3360]}],"sources":[{"fileName":"packages/log/src/transports/RotatingFileTransport.ts","line":7,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/RotatingFileTransport.ts#L7"}],"extendedTypes":[{"type":"reference","target":3301,"name":"FileTransportOptions","package":"@boost/log"}],"permalink":"/api/log/interface/RotatingFileTransportOptions","previousId":3505,"nextId":3420},{"id":3420,"name":"StreamTransportOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3422,"name":"eol","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"End of line character to append to a message. Defaults to "},{"kind":"code","text":"`os.EOL`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":3528,"name":"TransportOptions.eol"}},{"id":3423,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to format a log item into a message string. Default is transport dependent."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":97,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L97"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"},"inheritedFrom":{"type":"reference","target":3529,"name":"TransportOptions.format"}},{"id":3424,"name":"levels","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of log levels to only write messages for."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L99"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"inheritedFrom":{"type":"reference","target":3530,"name":"TransportOptions.levels"}},{"id":3421,"name":"stream","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"The stream to pipe messages to."}]},"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L7"}],"type":{"type":"reference","target":3510,"name":"Writable","package":"@boost/log"}}],"groups":[{"title":"Properties","children":[3422,3423,3424,3421]}],"sources":[{"fileName":"packages/log/src/transports/StreamTransport.ts","line":5,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/transports/StreamTransport.ts#L5"}],"extendedTypes":[{"type":"reference","target":3527,"name":"TransportOptions","package":"@boost/log"}],"permalink":"/api/log/interface/StreamTransportOptions","previousId":3359,"nextId":3527},{"id":3527,"name":"TransportOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":3528,"name":"eol","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"End of line character to append to a message. Defaults to "},{"kind":"code","text":"`os.EOL`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":95,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L95"}],"type":{"type":"intrinsic","name":"string"}},{"id":3529,"name":"format","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Function to format a log item into a message string. Default is transport dependent."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":97,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L97"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"}},{"id":3530,"name":"levels","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of log levels to only write messages for."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":99,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L99"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}}}],"groups":[{"title":"Properties","children":[3528,3529,3530]}],"sources":[{"fileName":"packages/log/src/types.ts","line":93,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L93"}],"extendedBy":[{"type":"reference","target":3301,"name":"FileTransportOptions"},{"type":"reference","target":3420,"name":"StreamTransportOptions"}],"permalink":"/api/log/interface/TransportOptions","previousId":3420,"nextId":3519},{"id":3519,"name":"Transportable","variant":"declaration","kind":256,"flags":{},"children":[{"id":3521,"name":"format","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":88,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L88"}],"type":{"type":"reference","target":3515,"name":"Formatter","package":"@boost/log"}},{"id":3520,"name":"levels","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":87,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L87"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}}},{"id":3522,"name":"write","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":90,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L90"}],"type":{"type":"reflection","declaration":{"id":3523,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":90,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L90"}],"signatures":[{"id":3524,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message and log item to the transport."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":90,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L90"}],"parameters":[{"id":3525,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":3526,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"union","types":[{"type":"intrinsic","name":"void"},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}]}}]}}}],"groups":[{"title":"Properties","children":[3521,3520,3522]}],"sources":[{"fileName":"packages/log/src/types.ts","line":86,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L86"}],"implementedBy":[{"type":"reference","target":3255,"name":"Transport"}],"permalink":"/api/log/interface/Transportable","previousId":3527,"nextId":3510},{"id":3510,"name":"Writable","variant":"declaration","kind":256,"flags":{},"children":[{"id":3511,"name":"write","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the configured stream."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L81"}],"type":{"type":"reflection","declaration":{"id":3512,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":81,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L81"}],"signatures":[{"id":3513,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Write a message to the configured stream."}]},"sources":[{"fileName":"packages/log/src/types.ts","line":81,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L81"}],"parameters":[{"id":3514,"name":"message","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[3511]}],"sources":[{"fileName":"packages/log/src/types.ts","line":79,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L79"}],"permalink":"/api/log/interface/Writable","previousId":3519,"nextId":3210},{"id":3515,"name":"Formatter","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":84,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L84"}],"type":{"type":"reflection","declaration":{"id":3516,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":84,"character":24,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L84"}],"signatures":[{"id":3517,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":3518,"name":"item","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3450,"name":"LogItem","package":"@boost/log"}}],"type":{"type":"intrinsic","name":"string"}}]}},"permalink":"/api/log#Formatter","previousId":3210,"nextId":3447},{"id":3447,"name":"LogLevel","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":1,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L1"}],"type":{"type":"union","types":[{"type":"literal","value":"debug"},{"type":"literal","value":"error"},{"type":"literal","value":"info"},{"type":"literal","value":"log"},{"type":"literal","value":"trace"},{"type":"literal","value":"warn"}]},"permalink":"/api/log#LogLevel","previousId":3515,"nextId":3448},{"id":3448,"name":"LogLevelLabels","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L3"}],"type":{"type":"mapped","parameter":"L","parameterType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"},"templateType":{"type":"intrinsic","name":"string"},"optionalModifier":"+"},"permalink":"/api/log#LogLevelLabels","previousId":3447,"nextId":3449},{"id":3449,"name":"LogMetadata","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L5"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript"},"permalink":"/api/log#LogMetadata","previousId":3448,"nextId":3531},{"id":3531,"name":"Rotation","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/log/src/types.ts","line":102,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/types.ts#L102"}],"type":{"type":"union","types":[{"type":"literal","value":"daily"},{"type":"literal","value":"hourly"},{"type":"literal","value":"monthly"},{"type":"literal","value":"weekly"}]},"permalink":"/api/log#Rotation","previousId":3449,"nextId":3224},{"id":3224,"name":"DEFAULT_LABELS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/log/src/constants.ts","line":8,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/constants.ts#L8"}],"type":{"type":"reference","target":3448,"name":"LogLevelLabels","package":"@boost/log"},"defaultValue":"...","permalink":"/api/log#DEFAULT_LABELS","previousId":3531,"nextId":3223},{"id":3223,"name":"LOG_LEVELS","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/log/src/constants.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/constants.ts#L6"}],"type":{"type":"array","elementType":{"type":"reference","target":3447,"name":"LogLevel","package":"@boost/log"}},"defaultValue":"...","permalink":"/api/log#LOG_LEVELS","previousId":3224,"nextId":3225},{"id":3225,"name":"MAX_LOG_SIZE","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/log/src/constants.ts","line":17,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/constants.ts#L17"}],"type":{"type":"literal","value":10485760},"defaultValue":"10_485_760","permalink":"/api/log#MAX_LOG_SIZE","previousId":3223},{"id":3226,"name":"createLogger","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/createLogger.ts","line":29,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/createLogger.ts#L29"}],"signatures":[{"id":3227,"name":"createLogger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a logger with any configured transports."}]},"sources":[{"fileName":"packages/log/src/createLogger.ts","line":29,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/createLogger.ts#L29"}],"parameters":[{"id":3228,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3505,"name":"LoggerOptions","package":"@boost/log"}}],"type":{"type":"reference","target":3485,"name":"LoggerFunction","package":"@boost/log"}}],"permalink":"/api/log/function/createLogger","previousId":3255,"nextId":3301}],"groups":[{"title":"Classes","children":[3279,3308,3229,3367,3425,3255]},{"title":"Functions","children":[3226]},{"title":"Interfaces","children":[3301,3450,3459,3472,3464,3485,3505,3359,3420,3527,3519,3510]},{"title":"Namespaces","children":[3210]},{"title":"Type Aliases","children":[3515,3447,3448,3449,3531]},{"title":"Variables","children":[3224,3223,3225]}],"sources":[{"fileName":"packages/log/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/index.ts#L1"}],"permalink":"/api/log"},"urlSlug":"log"},{"index":false,"label":"Test utilities","reflection":{"id":96,"name":"@boost/log/test","variant":"declaration","kind":2,"flags":{},"children":[{"id":97,"name":"mockLogger","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/log/src/test.ts","line":18,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/test.ts#L18"}],"signatures":[{"id":98,"name":"mockLogger","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns a Vitest spy that matches the return value shape of "},{"kind":"code","text":"`createLogger`"},{"kind":"text","text":".\\n\\n"},{"kind":"code","text":"```ts\\nimport { mockLogger } from \'@boost/log/test\';\\n\\nit(\'calls the logger\', async () => {\\n\\tconst log = await mockLogger();\\n\\n\\tlog(\'Something has happened\');\\n\\n\\texpect(log).toHaveBeenCalled();\\n});\\n```"}]},"sources":[{"fileName":"packages/log/src/test.ts","line":18,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/test.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":3485,"name":"LoggerFunction","package":"@boost/log"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/log-test/function/mockLogger"}],"groups":[{"title":"Functions","children":[97]}],"sources":[{"fileName":"packages/log/src/test.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/log/src/test.ts#L1"}],"permalink":"/api/log-test"},"urlSlug":"log-test"}],"packageName":"@boost/log","packageVersion":"5.0.0-alpha.3"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":99,"name":"@boost/module","variant":"declaration","kind":2,"flags":{},"children":[{"id":3557,"name":"ModuleLike","variant":"declaration","kind":2097152,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return shape of a module. The default export can be typed with\\nthe "},{"kind":"code","text":"`D`"},{"kind":"text","text":" generic slot, and the named exports can be typed with\\nan object in the "},{"kind":"code","text":"`N`"},{"kind":"text","text":" generic slot.\\n\\nIf there is no default export (classic Node.js "},{"kind":"code","text":"`exports`"},{"kind":"text","text":" pattern),\\nthen "},{"kind":"code","text":"`void`"},{"kind":"text","text":" can be passed to the "},{"kind":"code","text":"`D`"},{"kind":"text","text":" generic, which will populate\\nthe "},{"kind":"code","text":"`default`"},{"kind":"text","text":" property with the named exports."}]},"sources":[{"fileName":"packages/module/src/types.ts","line":13,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L13"}],"typeParameters":[{"id":3561,"name":"D","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":3562,"name":"N","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":3563,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":13,"character":55,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L13"}]}}}],"type":{"type":"intersection","types":[{"type":"reference","target":3562,"name":"N","package":"@boost/module","refersToTypeParameter":true},{"type":"reflection","declaration":{"id":3558,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3560,"name":"__esModule","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/module/src/types.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":3559,"name":"default","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":14,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L14"}],"type":{"type":"conditional","checkType":{"type":"reference","target":3561,"name":"D","package":"@boost/module","refersToTypeParameter":true},"extendsType":{"type":"intrinsic","name":"void"},"trueType":{"type":"reference","target":3562,"name":"N","package":"@boost/module","refersToTypeParameter":true},"falseType":{"type":"reference","target":3561,"name":"D","package":"@boost/module","refersToTypeParameter":true}}}],"groups":[{"title":"Properties","children":[3560,3559]}],"sources":[{"fileName":"packages/module/src/types.ts","line":13,"character":65,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L13"}]}}]},"permalink":"/api/module#ModuleLike","previousId":3547,"nextId":3564},{"id":3564,"name":"PathLike","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":18,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L18"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reflection","declaration":{"id":3565,"name":"__type","variant":"declaration","kind":65536,"flags":{},"children":[{"id":3566,"name":"toString","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":18,"character":34,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L18"}],"type":{"type":"reflection","declaration":{"id":3567,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/module/src/types.ts","line":18,"character":44,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L18"}],"signatures":[{"id":3568,"name":"__type","variant":"signature","kind":4096,"flags":{},"type":{"type":"intrinsic","name":"string"}}]}}}],"groups":[{"title":"Properties","children":[3566]}],"sources":[{"fileName":"packages/module/src/types.ts","line":18,"character":32,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/types.ts#L18"}]}}]},"permalink":"/api/module#PathLike","previousId":3557},{"id":3532,"name":"interopModule","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/interopModule.ts","line":16,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/interopModule.ts#L16"}],"signatures":[{"id":3533,"name":"interopModule","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Formats the shape of an imported module to align with the\\nES module specification.\\n\\nFor ES or ES-like modules, returns the shape as-is.\\n\\nFor CommonJS modules, returns an object with the following:\\n- "},{"kind":"code","text":"`module.exports`"},{"kind":"text","text":" under the "},{"kind":"code","text":"`default`"},{"kind":"text","text":" property.\\n- "},{"kind":"code","text":"`exports.`"},{"kind":"text","text":" under properties of the same name,\\n and also under a "},{"kind":"code","text":"`default`"},{"kind":"text","text":" object."}]},"sources":[{"fileName":"packages/module/src/interopModule.ts","line":16,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/interopModule.ts#L16"}],"typeParameter":[{"id":3534,"name":"D","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":3535,"name":"N","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":3536,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":3537,"name":"result","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":3557,"typeArguments":[{"type":"reference","target":3534,"name":"D","package":"@boost/module","refersToTypeParameter":true},{"type":"reference","target":3535,"name":"N","package":"@boost/module","refersToTypeParameter":true}],"name":"ModuleLike","package":"@boost/module"}}],"permalink":"/api/module/function/interopModule","nextId":3545},{"id":3545,"name":"registerExtensions","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":48,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L48"}],"signatures":[{"id":3546,"name":"registerExtensions","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register "},{"kind":"code","text":"`.ts`"},{"kind":"text","text":" and "},{"kind":"code","text":"`.tsx`"},{"kind":"text","text":" file extensions into Node.js\'s resolution algorithm."}]},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":48,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L48"}],"type":{"type":"intrinsic","name":"void"}}],"permalink":"/api/module/function/registerExtensions","previousId":3532,"nextId":3538},{"id":3538,"name":"requireModule","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/requireModule.ts","line":33,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireModule.ts#L33"}],"signatures":[{"id":3539,"name":"requireModule","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Works in a similar fashion to the native NodeJS "},{"kind":"code","text":"`require()`"},{"kind":"text","text":", but can also\\nimport custom file types like TypeScript, and also returns a module shape\\nthat aligns with the ESM loader specification.\\n\\nWhen loading custom file types, the extension in the file path is optional,\\nas NodeJS will iterate through each extension until a file is found.\\n\\n"},{"kind":"code","text":"```ts\\nimport { requireModule } from \'@boost/module\';\\n\\nconst result = requireModule(\'../../some/module\');\\n```"},{"kind":"text","text":"\\n\\nCaveats and differences:\\n\\n- CommonJS files that utilize "},{"kind":"code","text":"`module.exports`"},{"kind":"text","text":" (default export) will have this\\n value returned under a "},{"kind":"code","text":"`default`"},{"kind":"text","text":" property, instead of being returned directly.\\n- CommonJS files that utilize multiple "},{"kind":"code","text":"`exports.`"},{"kind":"text","text":" (named exports) will\\n have these values returned as properties on the result object, and will also\\n be found on the "},{"kind":"code","text":"`default`"},{"kind":"text","text":" property.\\n- \\"ES module like\\" files will be returned as-is. These are files that are built\\n with Babel or TypeScript and export an "},{"kind":"code","text":"`__esModule`"},{"kind":"text","text":" internal property.\\n\\nThese changes align with "},{"kind":"code","text":"`import()`"},{"kind":"text","text":" and the ES module system. We made this\\ndecision for consistency and reliability."}]},"sources":[{"fileName":"packages/module/src/requireModule.ts","line":33,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireModule.ts#L33"}],"typeParameter":[{"id":3540,"name":"D","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":3541,"name":"N","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":3542,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":3543,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3564,"name":"PathLike","package":"@boost/module"}},{"id":3544,"name":"requirer","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeRequire"},"name":"NodeRequire","package":"@types/node","qualifiedName":"__global.NodeRequire"},"defaultValue":"require"}],"type":{"type":"reference","target":3557,"typeArguments":[{"type":"reference","target":3540,"name":"D","package":"@boost/module","refersToTypeParameter":true},{"type":"reference","target":3541,"name":"N","package":"@boost/module","refersToTypeParameter":true}],"name":"ModuleLike","package":"@boost/module"}}],"permalink":"/api/module/function/requireModule","previousId":3545,"nextId":3549},{"id":3549,"name":"requireTSModule","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L80"}],"signatures":[{"id":3550,"name":"requireTSModule","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Like "},{"kind":"code","text":"`requireModule`"},{"kind":"text","text":" but for loading TypeScript files ending in "},{"kind":"code","text":"`ts`"},{"kind":"text","text":" or "},{"kind":"code","text":"`tsx`"},{"kind":"text","text":".\\nWhen imported, will transform the file using the "},{"kind":"code","text":"`typescript`"},{"kind":"text","text":" package,\\nevaluate the code in the current module context, and apply the same process\\nto all child imports.\\n\\n"},{"kind":"code","text":"```ts\\nimport { requireTSModule } from \'@boost/module\';\\n\\nconst result = requireTSModule(\'../../some/module.ts\');\\n```"},{"kind":"text","text":"\\n\\n> This helper rarely needs to be used directly as "},{"kind":"code","text":"`requireModule`"},{"kind":"text","text":" will\\n> call it under the hood based on the file extension."}]},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":80,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L80"}],"typeParameter":[{"id":3551,"name":"D","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":3552,"name":"N","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":3553,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":3554,"name":"path","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":3564,"name":"PathLike","package":"@boost/module"}},{"id":3555,"name":"requirer","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/@types/node/globals.d.ts","qualifiedName":"__global.NodeRequire"},"name":"NodeRequire","package":"@types/node","qualifiedName":"__global.NodeRequire"},"defaultValue":"require"}],"type":{"type":"reference","target":3557,"typeArguments":[{"type":"reference","target":3551,"name":"D","package":"@boost/module","refersToTypeParameter":true},{"type":"reference","target":3552,"name":"N","package":"@boost/module","refersToTypeParameter":true}],"name":"ModuleLike","package":"@boost/module"}}],"permalink":"/api/module/function/requireTSModule","previousId":3538,"nextId":3547},{"id":3547,"name":"unregisterExtensions","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L58"}],"signatures":[{"id":3548,"name":"unregisterExtensions","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unregister "},{"kind":"code","text":"`.ts`"},{"kind":"text","text":" and "},{"kind":"code","text":"`.tsx`"},{"kind":"text","text":" file extensions."}]},"sources":[{"fileName":"packages/module/src/requireTSModule.ts","line":58,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/requireTSModule.ts#L58"}],"type":{"type":"intrinsic","name":"void"}}],"permalink":"/api/module/function/unregisterExtensions","previousId":3549,"nextId":3557}],"groups":[{"title":"Functions","children":[3532,3545,3538,3549,3547]},{"title":"Type Aliases","children":[3557,3564]}],"sources":[{"fileName":"packages/module/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/index.ts#L1"}],"permalink":"/api/module"},"urlSlug":"module"},{"index":false,"label":"Node.js hooks","reflection":{"id":100,"name":"@boost/module/loader","variant":"declaration","kind":2,"flags":{},"sources":[{"fileName":"packages/module/src/hooks/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/module/src/hooks/index.ts#L1"}],"permalink":"/api/module-loader"},"urlSlug":"module-loader"}],"packageName":"@boost/module","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":5,"name":"@boost/pipeline","variant":"declaration","kind":2,"flags":{},"children":[{"id":848,"name":"AggregatedPipeline","variant":"declaration","kind":128,"flags":{},"children":[{"id":850,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":851,"name":"new AggregatedPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":852,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":853,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":854,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":855,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true}},{"id":856,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}},{"id":857,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":858,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"type":{"type":"reference","target":848,"typeArguments":[{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"AggregatedPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":998,"name":"ParallelPipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":997,"name":"ParallelPipeline.constructor"}},{"id":877,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1024,"name":"ParallelPipeline.context"}},{"id":878,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":1025,"name":"ParallelPipeline.debug"}},{"id":875,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1022,"name":"ParallelPipeline.depth"}},{"id":876,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1023,"name":"ParallelPipeline.index"}},{"id":880,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1027,"name":"ParallelPipeline.onAfterRun"}},{"id":881,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1028,"name":"ParallelPipeline.onBeforeRun"}},{"id":882,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":883,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1029,"name":"ParallelPipeline.onRunWorkUnit"}},{"id":895,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":896,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1042,"name":"ParallelPipeline.options"}},{"id":879,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1026,"name":"ParallelPipeline.value"}},{"id":887,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":888,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParallelPipeline.id"}},"inheritedFrom":{"type":"reference","target":1034,"name":"ParallelPipeline.id"}},{"id":864,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L25"}],"signatures":[{"id":865,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a work unit to the list of items to process."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"}],"parameters":[{"id":866,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":867,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":868,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1010,"name":"ParallelPipeline.add"}},{"id":869,"name":"add","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"}],"parameters":[{"id":870,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":871,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1014,"name":"ParallelPipeline.add"}}],"inheritedFrom":{"type":"reference","target":1009,"name":"ParallelPipeline.add"}},{"id":861,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"signatures":[{"id":862,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"parameters":[{"id":863,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":1007,"name":"ParallelPipeline.blueprint"}}],"inheritedFrom":{"type":"reference","target":1006,"name":"ParallelPipeline.blueprint"}},{"id":897,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":898,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":899,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":900,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":901,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":902,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":903,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":904,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":905,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":906,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1044,"name":"ParallelPipeline.configure"}}],"inheritedFrom":{"type":"reference","target":1043,"name":"ParallelPipeline.configure"}},{"id":889,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"signatures":[{"id":890,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of registered work units for the current pipeline."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":891,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":1037,"name":"ParallelPipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":1036,"name":"ParallelPipeline.getWorkUnits"}},{"id":892,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":893,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":894,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1040,"name":"ParallelPipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":1039,"name":"ParallelPipeline.monitor"}},{"id":859,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/AggregatedPipeline.ts","line":15,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/AggregatedPipeline.ts#L15"}],"signatures":[{"id":860,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute all work units in parallel with a value being passed to each work unit.\\nWork units will synchronize regardless of race conditions and errors."}]},"sources":[{"fileName":"packages/pipeline/src/AggregatedPipeline.ts","line":15,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/AggregatedPipeline.ts#L15"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1369,"typeArguments":[{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"AggregatedResult","package":"@boost/pipeline"}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":1021,"name":"ParallelPipeline.run"}}],"overwrites":{"type":"reference","target":1020,"name":"ParallelPipeline.run"}}],"groups":[{"title":"Constructors","children":[850]},{"title":"Properties","children":[877,878,875,876,880,881,882,895,879]},{"title":"Accessors","children":[887]},{"title":"Methods","children":[864,861,897,889,892,859]}],"categories":[{"title":"Events","children":[880,881,882]},{"title":"__CATEGORY__","children":[850,877,878,875,876,895,879,887,864,861,897,889,892,859]}],"sources":[{"fileName":"packages/pipeline/src/AggregatedPipeline.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/AggregatedPipeline.ts#L6"}],"typeParameters":[{"id":907,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":908,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":909,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":996,"typeArguments":[{"type":"reflection","declaration":{"id":849,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/AggregatedPipeline.ts","line":10,"character":27,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/AggregatedPipeline.ts#L10"}]}},{"type":"reference","target":852,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":853,"name":"Input","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":854,"name":"Output","package":"@boost/pipeline","qualifiedName":"AggregatedPipeline.Output","refersToTypeParameter":true}],"name":"ParallelPipeline","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/AggregatedPipeline","nextId":910},{"id":910,"name":"ConcurrentPipeline","variant":"declaration","kind":128,"flags":{},"children":[{"id":912,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":913,"name":"new ConcurrentPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":914,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":915,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":916,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":917,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true}},{"id":918,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}},{"id":919,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":920,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"type":{"type":"reference","target":910,"typeArguments":[{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"ConcurrentPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":998,"name":"ParallelPipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":997,"name":"ParallelPipeline.constructor"}},{"id":939,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1024,"name":"ParallelPipeline.context"}},{"id":940,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":1025,"name":"ParallelPipeline.debug"}},{"id":937,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1022,"name":"ParallelPipeline.depth"}},{"id":938,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1023,"name":"ParallelPipeline.index"}},{"id":942,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1027,"name":"ParallelPipeline.onAfterRun"}},{"id":943,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1028,"name":"ParallelPipeline.onBeforeRun"}},{"id":944,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":945,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1029,"name":"ParallelPipeline.onRunWorkUnit"}},{"id":957,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":958,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1042,"name":"ParallelPipeline.options"}},{"id":941,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1026,"name":"ParallelPipeline.value"}},{"id":949,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":950,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParallelPipeline.id"}},"inheritedFrom":{"type":"reference","target":1034,"name":"ParallelPipeline.id"}},{"id":926,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L25"}],"signatures":[{"id":927,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a work unit to the list of items to process."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"}],"parameters":[{"id":928,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":929,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":930,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1010,"name":"ParallelPipeline.add"}},{"id":931,"name":"add","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"}],"parameters":[{"id":932,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":933,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1014,"name":"ParallelPipeline.add"}}],"inheritedFrom":{"type":"reference","target":1009,"name":"ParallelPipeline.add"}},{"id":923,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"signatures":[{"id":924,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"parameters":[{"id":925,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":1007,"name":"ParallelPipeline.blueprint"}}],"inheritedFrom":{"type":"reference","target":1006,"name":"ParallelPipeline.blueprint"}},{"id":959,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":960,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":961,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":962,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":963,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":964,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":965,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":966,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":967,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":968,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1044,"name":"ParallelPipeline.configure"}}],"inheritedFrom":{"type":"reference","target":1043,"name":"ParallelPipeline.configure"}},{"id":951,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"signatures":[{"id":952,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of registered work units for the current pipeline."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":953,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":1037,"name":"ParallelPipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":1036,"name":"ParallelPipeline.getWorkUnits"}},{"id":954,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":955,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":956,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1040,"name":"ParallelPipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":1039,"name":"ParallelPipeline.monitor"}},{"id":921,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ConcurrentPipeline.ts","line":14,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ConcurrentPipeline.ts#L14"}],"signatures":[{"id":922,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute all work units in parallel with a value being passed to each work unit.\\nIf an error occurs, the pipeline will abort early, otherwise return a list of all results."}]},"sources":[{"fileName":"packages/pipeline/src/ConcurrentPipeline.ts","line":14,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ConcurrentPipeline.ts#L14"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":1021,"name":"ParallelPipeline.run"}}],"overwrites":{"type":"reference","target":1020,"name":"ParallelPipeline.run"}}],"groups":[{"title":"Constructors","children":[912]},{"title":"Properties","children":[939,940,937,938,942,943,944,957,941]},{"title":"Accessors","children":[949]},{"title":"Methods","children":[926,923,959,951,954,921]}],"categories":[{"title":"Events","children":[942,943,944]},{"title":"__CATEGORY__","children":[912,939,940,937,938,957,941,949,926,923,959,951,954,921]}],"sources":[{"fileName":"packages/pipeline/src/ConcurrentPipeline.ts","line":5,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ConcurrentPipeline.ts#L5"}],"typeParameters":[{"id":969,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":970,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":971,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":996,"typeArguments":[{"type":"reflection","declaration":{"id":911,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ConcurrentPipeline.ts","line":9,"character":27,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ConcurrentPipeline.ts#L9"}]}},{"type":"reference","target":914,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":915,"name":"Input","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":916,"name":"Output","package":"@boost/pipeline","qualifiedName":"ConcurrentPipeline.Output","refersToTypeParameter":true}],"name":"ParallelPipeline","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/ConcurrentPipeline","previousId":848,"nextId":977},{"id":977,"name":"Context","variant":"declaration","kind":128,"flags":{},"children":[{"id":978,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":979,"name":"new Context","variant":"signature","kind":16384,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}}]},{"id":980,"name":"clone","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Context.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Context.ts#L15"}],"signatures":[{"id":981,"name":"clone","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create a new instance of the current context and shallow clone all properties."}]},"sources":[{"fileName":"packages/pipeline/src/Context.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Context.ts#L15"}],"parameters":[{"id":982,"name":"args","variant":"param","kind":32768,"flags":{"isRest":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"any"}}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[978]},{"title":"Methods","children":[980]}],"sources":[{"fileName":"packages/pipeline/src/Context.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Context.ts#L11"}],"permalink":"/api/pipeline/class/Context","previousId":910,"nextId":983},{"id":983,"name":"Monitor","variant":"declaration","kind":128,"flags":{},"children":[{"id":984,"name":"constructor","variant":"declaration","kind":512,"flags":{},"signatures":[{"id":985,"name":"new Monitor","variant":"signature","kind":16384,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}]},{"id":986,"name":"onPipelineAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a pipeline class has ran."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":12,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L12"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1386,"name":"AnyPipeline","package":"@boost/pipeline"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":987,"name":"onPipelineBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a pipeline class is ran."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":18,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L18"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1386,"name":"AnyPipeline","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":988,"name":"onPipelineRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a pipeline\'s work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":24,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L24"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1386,"name":"AnyPipeline","package":"@boost/pipeline"},{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":989,"name":"onWorkUnitFail","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when any work unit has failed."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":30,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L30"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":990,"name":"onWorkUnitPass","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when any work unit has passed."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":36,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":991,"name":"onWorkUnitRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when any work unit is ran."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":42,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/BailEvent.ts","qualifiedName":"BailEvent"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"BailEvent","package":"@boost/event"},"defaultValue":"..."},{"id":992,"name":"onWorkUnitSkip","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when any work unit is skipped."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L48"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"},{"type":"intrinsic","name":"unknown"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":993,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":54,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L54"}],"signatures":[{"id":994,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor events for the provided pipeline, its work units, and all other\\npipelines and work units down the hierarchical tree."}]},"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":54,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L54"}],"parameters":[{"id":995,"name":"pipeline","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1386,"name":"AnyPipeline","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[984]},{"title":"Properties","children":[986,987,988,989,990,991,992]},{"title":"Methods","children":[993]}],"categories":[{"title":"Events","children":[986,987,988,989,990,991,992]},{"title":"__CATEGORY__","children":[984,993]}],"sources":[{"fileName":"packages/pipeline/src/Monitor.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Monitor.ts#L7"}],"permalink":"/api/pipeline/class/Monitor","previousId":977,"nextId":996},{"id":996,"name":"ParallelPipeline","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":997,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":998,"name":"new ParallelPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":999,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1000,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1001,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1002,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":1003,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true}},{"id":1004,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}},{"id":1005,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":996,"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"ParallelPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.constructor"}},{"id":1024,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.context"}},{"id":1025,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.debug"}},{"id":1022,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.depth"}},{"id":1023,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.index"}},{"id":1027,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onAfterRun"}},{"id":1028,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onBeforeRun"}},{"id":1029,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1030,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onRunWorkUnit"}},{"id":1042,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.options"}},{"id":1026,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.value"}},{"id":1034,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":1035,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.id"}},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.id"}},{"id":1009,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L25"}],"signatures":[{"id":1010,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a work unit to the list of items to process."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"}],"parameters":[{"id":1011,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1012,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1013,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"this"}},{"id":1014,"name":"add","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"}],"parameters":[{"id":1015,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1016,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":1006,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"signatures":[{"id":1007,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":16,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L16"}],"parameters":[{"id":1008,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"overwrites":{"type":"reference","target":-1,"name":"Pipeline.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Pipeline.blueprint"}},{"id":1043,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1044,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1045,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1046,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1047,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1048,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.configure"}},{"id":1036,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"signatures":[{"id":1037,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of registered work units for the current pipeline."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1038,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.getWorkUnits"}},{"id":1039,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":1040,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":1041,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.monitor"}},{"id":1020,"name":"run","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":61,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L61"}],"signatures":[{"id":1021,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run and process the work unit\'s asynchronously."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":61,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L61"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"unknown"}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[997]},{"title":"Properties","children":[1024,1025,1022,1023,1027,1028,1029,1042,1026]},{"title":"Accessors","children":[1034]},{"title":"Methods","children":[1009,1006,1043,1036,1039,1020]}],"categories":[{"title":"Events","children":[1027,1028,1029]},{"title":"__CATEGORY__","children":[997,1024,1025,1022,1023,1042,1026,1034,1009,1006,1043,1036,1039,1020]}],"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":9,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L9"}],"typeParameters":[{"id":1049,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1050,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1051,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1052,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/pipeline/src/Pipeline.ts","qualifiedName":"Pipeline"},"typeArguments":[{"type":"reference","target":999,"name":"Options","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1000,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1001,"name":"Input","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1002,"name":"Output","package":"@boost/pipeline","qualifiedName":"ParallelPipeline.Output","refersToTypeParameter":true}],"name":"Pipeline","package":"@boost/pipeline"}],"extendedBy":[{"type":"reference","target":848,"name":"AggregatedPipeline"},{"type":"reference","target":910,"name":"ConcurrentPipeline"},{"type":"reference","target":1063,"name":"PooledPipeline"}],"permalink":"/api/pipeline/class/ParallelPipeline","previousId":983,"nextId":1063},{"id":1063,"name":"PooledPipeline","variant":"declaration","kind":128,"flags":{},"children":[{"id":1064,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":1065,"name":"new PooledPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":1066,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1067,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1068,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":1069,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true}},{"id":1070,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}},{"id":1071,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}}],"type":{"type":"reference","target":1063,"typeArguments":[{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"PooledPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":998,"name":"ParallelPipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":997,"name":"ParallelPipeline.constructor"}},{"id":1101,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1024,"name":"ParallelPipeline.context"}},{"id":1102,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":1025,"name":"ParallelPipeline.debug"}},{"id":1099,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1022,"name":"ParallelPipeline.depth"}},{"id":1100,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1023,"name":"ParallelPipeline.index"}},{"id":1104,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1027,"name":"ParallelPipeline.onAfterRun"}},{"id":1105,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1028,"name":"ParallelPipeline.onBeforeRun"}},{"id":1106,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1107,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1029,"name":"ParallelPipeline.onRunWorkUnit"}},{"id":1119,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1042,"name":"ParallelPipeline.options"}},{"id":1103,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1026,"name":"ParallelPipeline.value"}},{"id":1111,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":1112,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"ParallelPipeline.id"}},"inheritedFrom":{"type":"reference","target":1034,"name":"ParallelPipeline.id"}},{"id":1088,"name":"add","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"},{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":25,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L25"}],"signatures":[{"id":1089,"name":"add","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Add a work unit to the list of items to process."}]},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L23"}],"parameters":[{"id":1090,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1091,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1092,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1010,"name":"ParallelPipeline.add"}},{"id":1093,"name":"add","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/ParallelPipeline.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/ParallelPipeline.ts#L24"}],"parameters":[{"id":1094,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1095,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1014,"name":"ParallelPipeline.add"}}],"inheritedFrom":{"type":"reference","target":1009,"name":"ParallelPipeline.add"}},{"id":1079,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":34,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L34"}],"signatures":[{"id":1080,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":34,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L34"}],"parameters":[{"id":1081,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":1007,"name":"ParallelPipeline.blueprint"}}],"overwrites":{"type":"reference","target":1006,"name":"ParallelPipeline.blueprint"}},{"id":1120,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1121,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1122,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1123,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1124,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1125,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1044,"name":"ParallelPipeline.configure"}}],"inheritedFrom":{"type":"reference","target":1043,"name":"ParallelPipeline.configure"}},{"id":1113,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"signatures":[{"id":1114,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a list of registered work units for the current pipeline."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":73,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L73"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1115,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":1037,"name":"ParallelPipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":1036,"name":"ParallelPipeline.getWorkUnits"}},{"id":1116,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":1117,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":1118,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1040,"name":"ParallelPipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":1039,"name":"ParallelPipeline.monitor"}},{"id":1082,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":49,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L49"}],"signatures":[{"id":1083,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute all work units in parallel, in a pool with a max concurrency,\\nwith a value being passed to each work unit.\\nWork units will synchronize regardless of race conditions and errors."}]},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":49,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L49"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1369,"typeArguments":[{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"AggregatedResult","package":"@boost/pipeline"}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":1021,"name":"ParallelPipeline.run"}}],"overwrites":{"type":"reference","target":1020,"name":"ParallelPipeline.run"}}],"groups":[{"title":"Constructors","children":[1064]},{"title":"Properties","children":[1101,1102,1099,1100,1104,1105,1106,1119,1103]},{"title":"Accessors","children":[1111]},{"title":"Methods","children":[1088,1079,1120,1113,1116,1082]}],"categories":[{"title":"Events","children":[1104,1105,1106]},{"title":"__CATEGORY__","children":[1064,1101,1102,1099,1100,1119,1103,1111,1088,1079,1120,1113,1116,1082]}],"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":23,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L23"}],"typeParameters":[{"id":1126,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1127,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1128,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":996,"typeArguments":[{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"},{"type":"reference","target":1066,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1067,"name":"Input","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1068,"name":"Output","package":"@boost/pipeline","qualifiedName":"PooledPipeline.Output","refersToTypeParameter":true}],"name":"ParallelPipeline","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/PooledPipeline","previousId":996,"nextId":1135},{"id":1135,"name":"Routine","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1136,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L47"}],"signatures":[{"id":1137,"name":"new Routine","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L47"}],"typeParameter":[{"id":1138,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1139,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1140,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1141,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":1142,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":1143,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1144,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1135,"typeArguments":[{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true},{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true},{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Routine","package":"@boost/pipeline"},"overwrites":{"type":"reference","target":1455,"name":"WorkUnit.constructor"}}],"overwrites":{"type":"reference","target":1454,"name":"WorkUnit.constructor"}},{"id":1145,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"}},{"id":1195,"name":"depth","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current depth of nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L18"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1462,"name":"WorkUnit.depth"}},{"id":1196,"name":"index","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current index amongst sibling work units."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L20"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1463,"name":"WorkUnit.index"}},{"id":1198,"name":"input","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L24"}],"type":{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1465,"name":"WorkUnit.input"}},{"id":1146,"name":"key","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":31,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L31"}],"type":{"type":"intrinsic","name":"string"}},{"id":1147,"name":"onCommand","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after "},{"kind":"code","text":"`execa`"},{"kind":"text","text":" was executed."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":37,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L37"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1148,"name":"onCommandData","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called while a command is being executed."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":43,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L43"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"string"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1202,"name":"onFail","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution fails."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":36,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]},{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1469,"name":"WorkUnit.onFail"}},{"id":1203,"name":"onPass","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution succeeds."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":42,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true},{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1470,"name":"WorkUnit.onPass"}},{"id":1204,"name":"onRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a work unit is executed. Can return "},{"kind":"code","text":"`true`"},{"kind":"text","text":" to skip the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L48"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/BailEvent.ts","qualifiedName":"BailEvent"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"BailEvent","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1471,"name":"WorkUnit.onRun"}},{"id":1205,"name":"onSkip","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution is skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":54,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L54"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1472,"name":"WorkUnit.onSkip"}},{"id":1228,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1497,"name":"WorkUnit.options"}},{"id":1197,"name":"output","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L22"}],"type":{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1464,"name":"WorkUnit.output"}},{"id":1199,"name":"startTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L26"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1466,"name":"WorkUnit.startTime"}},{"id":1200,"name":"statusText","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L28"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'","inheritedFrom":{"type":"reference","target":1467,"name":"WorkUnit.statusText"}},{"id":1201,"name":"stopTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L30"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1468,"name":"WorkUnit.stopTime"}},{"id":1206,"name":"title","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":56,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L56"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":1473,"name":"WorkUnit.title"}},{"id":1207,"name":"id","variant":"declaration","kind":262144,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique ID of the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"getSignature":{"id":1208,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"WorkUnit.id"}},"inheritedFrom":{"type":"reference","target":1476,"name":"WorkUnit.id"}},{"id":1235,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"signatures":[{"id":1236,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"parameters":[{"id":1237,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":1238,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":1505,"name":"WorkUnit.blueprint"}}],"inheritedFrom":{"type":"reference","target":1504,"name":"WorkUnit.blueprint"}},{"id":1229,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1230,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1231,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1232,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1233,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1234,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1499,"name":"WorkUnit.configure"}}],"inheritedFrom":{"type":"reference","target":1498,"name":"WorkUnit.configure"}},{"id":1156,"name":"createAggregatedPipeline","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":103,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L103"}],"signatures":[{"id":1157,"name":"createAggregatedPipeline","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`AggregatedPipeline`"},{"kind":"text","text":". This pipeline will execute all work units\\nin parallel without interruption. Returns an object with a list of errors and results\\nonce all resolve."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":103,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L103"}],"typeParameter":[{"id":1158,"name":"C","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1159,"name":"I","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1160,"name":"O","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1159,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"parameters":[{"id":1161,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1158,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1162,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1159,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"type":{"type":"reference","target":848,"typeArguments":[{"type":"reference","target":1158,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1159,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1160,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"AggregatedPipeline","package":"@boost/pipeline"}}]},{"id":1163,"name":"createConcurrentPipeline","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":111,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L111"}],"signatures":[{"id":1164,"name":"createConcurrentPipeline","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`ConcurrentPipeline`"},{"kind":"text","text":". This pipeline will execute all work units\\nin parallel. Returns a list of values once all resolve."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":111,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L111"}],"typeParameter":[{"id":1165,"name":"C","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1166,"name":"I","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1167,"name":"O","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1166,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"parameters":[{"id":1168,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1165,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1169,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1166,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"type":{"type":"reference","target":910,"typeArguments":[{"type":"reference","target":1165,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1166,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1167,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"ConcurrentPipeline","package":"@boost/pipeline"}}]},{"id":1170,"name":"createPooledPipeline","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":120,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L120"}],"signatures":[{"id":1171,"name":"createPooledPipeline","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`PooledPipeline`"},{"kind":"text","text":". This pipeline will execute a distinct set of work units\\nin parallel without interruption, based on a max concurrency, until all work units have ran.\\nReturns a list of errors and results once all resolve."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":120,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L120"}],"typeParameter":[{"id":1172,"name":"C","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1173,"name":"I","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1174,"name":"O","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1173,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"parameters":[{"id":1175,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1172,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1176,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1173,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1177,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1059,"name":"PooledOptions","package":"@boost/pipeline"}}],"type":{"type":"reference","target":1063,"typeArguments":[{"type":"reference","target":1172,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1173,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1174,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"PooledPipeline","package":"@boost/pipeline"}}]},{"id":1178,"name":"createWaterfallPipeline","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":133,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L133"}],"signatures":[{"id":1179,"name":"createWaterfallPipeline","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`WaterfallPipeline`"},{"kind":"text","text":". This pipeline will execute each work unit one by one,\\nwith the return value of the previous being passed to the next. Returns the final value once\\nall resolve."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":133,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L133"}],"typeParameter":[{"id":1180,"name":"C","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1181,"name":"I","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":1182,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1180,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1183,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1181,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}}],"type":{"type":"reference","target":1390,"typeArguments":[{"type":"reference","target":1180,"name":"C","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1181,"name":"I","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"WaterfallPipeline","package":"@boost/pipeline"}}]},{"id":1191,"name":"execute","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":163,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L163"}],"signatures":[{"id":1192,"name":"execute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute the current routine and return a new value."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":163,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L163"}],"parameters":[{"id":1193,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1194,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]},{"id":1150,"name":"executeCommand","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":64,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L64"}],"signatures":[{"id":1151,"name":"executeCommand","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute a command with the given arguments and pass the results through a promise."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":64,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L64"}],"parameters":[{"id":1152,"name":"command","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1153,"name":"args","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}},{"id":1154,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"intersection","types":[{"type":"reflection","declaration":{"id":1155,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"node_modules/execa/index.d.ts","line":276,"character":83}]}},{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"CommonOptions"},"typeArguments":[{"type":"literal","value":"utf8"}],"name":"CommonOptions","package":"execa"},{"type":"reference","target":1129,"name":"ExecuteCommandOptions","package":"@boost/pipeline"}]},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"ExecaReturnValue"},"typeArguments":[{"type":"intrinsic","name":"string"}],"name":"ExecaReturnValue","package":"execa"}],"name":"Promise","package":"typescript"}}]},{"id":1209,"name":"hasFailed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"signatures":[{"id":1210,"name":"hasFailed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task failed when executing."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1479,"name":"WorkUnit.hasFailed"}}],"inheritedFrom":{"type":"reference","target":1478,"name":"WorkUnit.hasFailed"}},{"id":1211,"name":"hasPassed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"signatures":[{"id":1212,"name":"hasPassed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task executed successfully."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1481,"name":"WorkUnit.hasPassed"}}],"inheritedFrom":{"type":"reference","target":1480,"name":"WorkUnit.hasPassed"}},{"id":1213,"name":"isComplete","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"signatures":[{"id":1214,"name":"isComplete","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has been completed in any form."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1483,"name":"WorkUnit.isComplete"}}],"inheritedFrom":{"type":"reference","target":1482,"name":"WorkUnit.isComplete"}},{"id":1215,"name":"isPending","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"signatures":[{"id":1216,"name":"isPending","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has not been executed yet."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1485,"name":"WorkUnit.isPending"}}],"inheritedFrom":{"type":"reference","target":1484,"name":"WorkUnit.isPending"}},{"id":1217,"name":"isRunning","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"signatures":[{"id":1218,"name":"isRunning","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task is currently running."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1487,"name":"WorkUnit.isRunning"}}],"inheritedFrom":{"type":"reference","target":1486,"name":"WorkUnit.isRunning"}},{"id":1219,"name":"isSkipped","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"signatures":[{"id":1220,"name":"isSkipped","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task was or will be skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1489,"name":"WorkUnit.isSkipped"}}],"inheritedFrom":{"type":"reference","target":1488,"name":"WorkUnit.isSkipped"}},{"id":1221,"name":"run","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"signatures":[{"id":1222,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the current task by executing it and performing any before and after processes."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"parameters":[{"id":1223,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1224,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","target":1491,"name":"WorkUnit.run"}}],"inheritedFrom":{"type":"reference","target":1490,"name":"WorkUnit.run"}},{"id":1184,"name":"setMonitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L140"}],"signatures":[{"id":1185,"name":"setMonitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set the monitor to pass to nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":140,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L140"}],"parameters":[{"id":1186,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"}}]},{"id":1225,"name":"skip","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"signatures":[{"id":1226,"name":"skip","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mark a task as skipped if the condition is true."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"parameters":[{"id":1227,"name":"condition","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true"}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1495,"name":"WorkUnit.skip"}}],"inheritedFrom":{"type":"reference","target":1494,"name":"WorkUnit.skip"}}],"groups":[{"title":"Constructors","children":[1136]},{"title":"Properties","children":[1145,1195,1196,1198,1146,1147,1148,1202,1203,1204,1205,1228,1197,1199,1200,1201,1206]},{"title":"Accessors","children":[1207]},{"title":"Methods","children":[1235,1229,1156,1163,1170,1178,1191,1150,1209,1211,1213,1215,1217,1219,1221,1184,1225]}],"categories":[{"title":"Events","children":[1147,1148,1202,1203,1204,1205]},{"title":"__CATEGORY__","children":[1136,1145,1195,1196,1198,1146,1228,1197,1199,1200,1201,1206,1207,1235,1229,1156,1163,1170,1178,1191,1150,1209,1211,1213,1215,1217,1219,1221,1184,1225]}],"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":24,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L24"}],"typeParameters":[{"id":1239,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1240,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1241,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1242,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":27,"character":26,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L27"}]}}}],"extendedTypes":[{"type":"reference","target":1453,"typeArguments":[{"type":"reference","target":1140,"name":"Options","package":"@boost/pipeline","qualifiedName":"Routine.Options","refersToTypeParameter":true},{"type":"reference","target":1139,"name":"Input","package":"@boost/pipeline","qualifiedName":"Routine.Input","refersToTypeParameter":true},{"type":"reference","target":1138,"name":"Output","package":"@boost/pipeline","qualifiedName":"Routine.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/Routine","previousId":1063,"nextId":1243},{"id":1243,"name":"SerialPipeline","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1244,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":1245,"name":"new SerialPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":1246,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1247,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1248,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1249,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}}],"parameters":[{"id":1250,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true}},{"id":1251,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}},{"id":1252,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.constructor"}},{"id":1274,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.context"}},{"id":1275,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.debug"}},{"id":1272,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.depth"}},{"id":1273,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.index"}},{"id":1277,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onAfterRun"}},{"id":1278,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onBeforeRun"}},{"id":1279,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1280,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.onRunWorkUnit"}},{"id":1289,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.options"}},{"id":1253,"name":"root","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L17"}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"SerialPipeline","package":"@boost/pipeline"},"defaultValue":"..."},{"id":1276,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.value"}},{"id":1284,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":1285,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.id"}},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.id"}},{"id":1254,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L20"}],"signatures":[{"id":1255,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L20"}],"parameters":[{"id":1256,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"overwrites":{"type":"reference","target":-1,"name":"Pipeline.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Pipeline.blueprint"}},{"id":1290,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1291,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1292,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1293,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1294,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1295,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.configure"}},{"id":1267,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L65"}],"signatures":[{"id":1268,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Traverse the linked list to return a list of work units in defined order."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L65"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1269,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"overwrites":{"type":"reference","target":-1,"name":"Pipeline.getWorkUnits"}}],"overwrites":{"type":"reference","target":-1,"name":"Pipeline.getWorkUnits"}},{"id":1286,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":1287,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":1288,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Pipeline.monitor"}},{"id":1257,"name":"pipe","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L27"},{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L32"},{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L33"}],"signatures":[{"id":1258,"name":"pipe","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Pipe a work unit to be ran with the return value of the previous work unit."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L27"}],"typeParameter":[{"id":1259,"name":"O","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1260,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1261,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1262,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"}},{"id":1263,"name":"pipe","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L32"}],"typeParameter":[{"id":1264,"name":"O","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1265,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1266,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"}}]},{"id":1270,"name":"run","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":73,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L73"}],"signatures":[{"id":1271,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run and process the work units synchronously."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":73,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L73"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[1244]},{"title":"Properties","children":[1274,1275,1272,1273,1277,1278,1279,1289,1253,1276]},{"title":"Accessors","children":[1284]},{"title":"Methods","children":[1254,1290,1267,1286,1257,1270]}],"categories":[{"title":"Events","children":[1277,1278,1279]},{"title":"__CATEGORY__","children":[1244,1274,1275,1272,1273,1289,1253,1276,1284,1254,1290,1267,1286,1257,1270]}],"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":8,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L8"}],"typeParameters":[{"id":1296,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1297,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1298,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1299,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/pipeline/src/Pipeline.ts","qualifiedName":"Pipeline"},"typeArguments":[{"type":"reference","target":1246,"name":"Options","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Options","refersToTypeParameter":true},{"type":"reference","target":1247,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1248,"name":"Input","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1249,"name":"Output","package":"@boost/pipeline","qualifiedName":"SerialPipeline.Output","refersToTypeParameter":true}],"name":"Pipeline","package":"@boost/pipeline"}],"extendedBy":[{"type":"reference","target":1390,"name":"WaterfallPipeline"}],"permalink":"/api/pipeline/class/SerialPipeline","previousId":1135,"nextId":1300},{"id":1300,"name":"Task","variant":"declaration","kind":128,"flags":{},"children":[{"id":1302,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L65"}],"signatures":[{"id":1303,"name":"new Task","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L65"}],"typeParameter":[{"id":1304,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1305,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}}],"parameters":[{"id":1306,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1307,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true},{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1308,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":1309,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"type":{"type":"reference","target":1300,"typeArguments":[{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true},{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true}],"name":"Task","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":1455,"name":"WorkUnit.constructor"}}],"inheritedFrom":{"type":"reference","target":1454,"name":"WorkUnit.constructor"}},{"id":1313,"name":"depth","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current depth of nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L18"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1462,"name":"WorkUnit.depth"}},{"id":1314,"name":"index","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current index amongst sibling work units."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L20"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1463,"name":"WorkUnit.index"}},{"id":1316,"name":"input","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L24"}],"type":{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1465,"name":"WorkUnit.input"}},{"id":1320,"name":"onFail","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution fails."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":36,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]},{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1469,"name":"WorkUnit.onFail"}},{"id":1321,"name":"onPass","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution succeeds."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":42,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true},{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1470,"name":"WorkUnit.onPass"}},{"id":1322,"name":"onRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a work unit is executed. Can return "},{"kind":"code","text":"`true`"},{"kind":"text","text":" to skip the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L48"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/BailEvent.ts","qualifiedName":"BailEvent"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"BailEvent","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1471,"name":"WorkUnit.onRun"}},{"id":1323,"name":"onSkip","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution is skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":54,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L54"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1472,"name":"WorkUnit.onSkip"}},{"id":1346,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1347,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1497,"name":"WorkUnit.options"}},{"id":1315,"name":"output","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L22"}],"type":{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1464,"name":"WorkUnit.output"}},{"id":1317,"name":"startTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L26"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1466,"name":"WorkUnit.startTime"}},{"id":1318,"name":"statusText","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L28"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'","inheritedFrom":{"type":"reference","target":1467,"name":"WorkUnit.statusText"}},{"id":1319,"name":"stopTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L30"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1468,"name":"WorkUnit.stopTime"}},{"id":1324,"name":"title","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":56,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L56"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":1473,"name":"WorkUnit.title"}},{"id":1325,"name":"id","variant":"declaration","kind":262144,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique ID of the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"getSignature":{"id":1326,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"WorkUnit.id"}},"inheritedFrom":{"type":"reference","target":1476,"name":"WorkUnit.id"}},{"id":1310,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Task.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Task.ts#L7"}],"signatures":[{"id":1311,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/pipeline/src/Task.ts","line":7,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Task.ts#L7"}],"parameters":[{"id":1312,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"overwrites":{"type":"reference","target":1505,"name":"WorkUnit.blueprint"}}],"overwrites":{"type":"reference","target":1504,"name":"WorkUnit.blueprint"}},{"id":1348,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1349,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1350,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":1351,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1352,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1353,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1354,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1355,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":1356,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1357,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1499,"name":"WorkUnit.configure"}}],"inheritedFrom":{"type":"reference","target":1498,"name":"WorkUnit.configure"}},{"id":1327,"name":"hasFailed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"signatures":[{"id":1328,"name":"hasFailed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task failed when executing."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1479,"name":"WorkUnit.hasFailed"}}],"inheritedFrom":{"type":"reference","target":1478,"name":"WorkUnit.hasFailed"}},{"id":1329,"name":"hasPassed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"signatures":[{"id":1330,"name":"hasPassed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task executed successfully."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1481,"name":"WorkUnit.hasPassed"}}],"inheritedFrom":{"type":"reference","target":1480,"name":"WorkUnit.hasPassed"}},{"id":1331,"name":"isComplete","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"signatures":[{"id":1332,"name":"isComplete","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has been completed in any form."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1483,"name":"WorkUnit.isComplete"}}],"inheritedFrom":{"type":"reference","target":1482,"name":"WorkUnit.isComplete"}},{"id":1333,"name":"isPending","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"signatures":[{"id":1334,"name":"isPending","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has not been executed yet."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1485,"name":"WorkUnit.isPending"}}],"inheritedFrom":{"type":"reference","target":1484,"name":"WorkUnit.isPending"}},{"id":1335,"name":"isRunning","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"signatures":[{"id":1336,"name":"isRunning","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task is currently running."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1487,"name":"WorkUnit.isRunning"}}],"inheritedFrom":{"type":"reference","target":1486,"name":"WorkUnit.isRunning"}},{"id":1337,"name":"isSkipped","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"signatures":[{"id":1338,"name":"isSkipped","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task was or will be skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"type":{"type":"intrinsic","name":"boolean"},"inheritedFrom":{"type":"reference","target":1489,"name":"WorkUnit.isSkipped"}}],"inheritedFrom":{"type":"reference","target":1488,"name":"WorkUnit.isSkipped"}},{"id":1339,"name":"run","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"signatures":[{"id":1340,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the current task by executing it and performing any before and after processes."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"parameters":[{"id":1341,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1342,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},"inheritedFrom":{"type":"reference","target":1491,"name":"WorkUnit.run"}}],"inheritedFrom":{"type":"reference","target":1490,"name":"WorkUnit.run"}},{"id":1343,"name":"skip","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"signatures":[{"id":1344,"name":"skip","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mark a task as skipped if the condition is true."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"parameters":[{"id":1345,"name":"condition","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true"}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1495,"name":"WorkUnit.skip"}}],"inheritedFrom":{"type":"reference","target":1494,"name":"WorkUnit.skip"}}],"groups":[{"title":"Constructors","children":[1302]},{"title":"Properties","children":[1313,1314,1316,1320,1321,1322,1323,1346,1315,1317,1318,1319,1324]},{"title":"Accessors","children":[1325]},{"title":"Methods","children":[1310,1348,1327,1329,1331,1333,1335,1337,1339,1343]}],"categories":[{"title":"Events","children":[1320,1321,1322,1323]},{"title":"__CATEGORY__","children":[1302,1313,1314,1316,1346,1315,1317,1318,1319,1324,1325,1310,1348,1327,1329,1331,1333,1335,1337,1339,1343]}],"sources":[{"fileName":"packages/pipeline/src/Task.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Task.ts#L4"}],"typeParameters":[{"id":1358,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1359,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1301,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Task.ts","line":4,"character":68,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Task.ts#L4"}]}},{"type":"reference","target":1304,"name":"Input","package":"@boost/pipeline","qualifiedName":"Task.Input","refersToTypeParameter":true},{"type":"reference","target":1305,"name":"Output","package":"@boost/pipeline","qualifiedName":"Task.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/Task","previousId":1243,"nextId":1390},{"id":1390,"name":"WaterfallPipeline","variant":"declaration","kind":128,"flags":{},"children":[{"id":1392,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"signatures":[{"id":1393,"name":"new WaterfallPipeline","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":47,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L47"}],"typeParameter":[{"id":1394,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1395,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":1396,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true}},{"id":1397,"name":"value","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}},{"id":1398,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reflection","declaration":{"id":1399,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"type":{"type":"reference","target":1390,"typeArguments":[{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"WaterfallPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":1245,"name":"SerialPipeline.constructor"}}],"inheritedFrom":{"type":"reference","target":1244,"name":"SerialPipeline.constructor"}},{"id":1424,"name":"context","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":19,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L19"}],"type":{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1274,"name":"SerialPipeline.context"}},{"id":1425,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":21,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L21"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"},"inheritedFrom":{"type":"reference","target":1275,"name":"SerialPipeline.debug"}},{"id":1422,"name":"depth","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1272,"name":"SerialPipeline.depth"}},{"id":1423,"name":"index","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L17"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","inheritedFrom":{"type":"reference","target":1273,"name":"SerialPipeline.index"}},{"id":1427,"name":"onAfterRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":29,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L29"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1277,"name":"SerialPipeline.onAfterRun"}},{"id":1428,"name":"onBeforeRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before the pipeline executes work units."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":35,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L35"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1278,"name":"SerialPipeline.onBeforeRun"}},{"id":1429,"name":"onRunWorkUnit","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a single work unit is executed."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":41,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L41"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1430,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1279,"name":"SerialPipeline.onRunWorkUnit"}},{"id":1439,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1440,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1289,"name":"SerialPipeline.options"}},{"id":1402,"name":"root","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L17"}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reflection","declaration":{"id":1403,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"SerialPipeline","package":"@boost/pipeline"},"defaultValue":"...","inheritedFrom":{"type":"reference","target":1253,"name":"SerialPipeline.root"}},{"id":1426,"name":"value","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":23,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L23"}],"type":{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},"inheritedFrom":{"type":"reference","target":1276,"name":"SerialPipeline.value"}},{"id":1434,"name":"id","variant":"declaration","kind":262144,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"getSignature":{"id":1435,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":66,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L66"}],"type":{"type":"intrinsic","name":"string"},"inheritedFrom":{"type":"reference","target":-1,"name":"SerialPipeline.id"}},"inheritedFrom":{"type":"reference","target":1284,"name":"SerialPipeline.id"}},{"id":1404,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L20"}],"signatures":[{"id":1405,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L20"}],"parameters":[{"id":1406,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":1255,"name":"SerialPipeline.blueprint"}}],"inheritedFrom":{"type":"reference","target":1254,"name":"SerialPipeline.blueprint"}},{"id":1441,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1442,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1443,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":1444,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1445,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1446,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1447,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1448,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reflection","declaration":{"id":1449,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reflection","declaration":{"id":1450,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":1291,"name":"SerialPipeline.configure"}}],"inheritedFrom":{"type":"reference","target":1290,"name":"SerialPipeline.configure"}},{"id":1419,"name":"getWorkUnits","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L65"}],"signatures":[{"id":1420,"name":"getWorkUnits","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Traverse the linked list to return a list of work units in defined order."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L65"}],"type":{"type":"array","elementType":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1421,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}},"inheritedFrom":{"type":"reference","target":1268,"name":"SerialPipeline.getWorkUnits"}}],"inheritedFrom":{"type":"reference","target":1267,"name":"SerialPipeline.getWorkUnits"}},{"id":1436,"name":"monitor","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"signatures":[{"id":1437,"name":"monitor","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Monitor all hierarchical pipelines, routines, and tasks being executed,\\nby listening to all applicable events."}]},"sources":[{"fileName":"packages/pipeline/src/Pipeline.ts","line":81,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Pipeline.ts#L81"}],"parameters":[{"id":1438,"name":"monitor","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":983,"name":"Monitor","package":"@boost/pipeline"}}],"type":{"type":"intrinsic","name":"this"},"inheritedFrom":{"type":"reference","target":1287,"name":"SerialPipeline.monitor"}}],"inheritedFrom":{"type":"reference","target":1286,"name":"SerialPipeline.monitor"}},{"id":1407,"name":"pipe","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L27"},{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L32"},{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":33,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L33"}],"signatures":[{"id":1408,"name":"pipe","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Pipe a work unit to be ran with the return value of the previous work unit."}]},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L27"}],"typeParameter":[{"id":1409,"name":"O","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1410,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1411,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1412,"name":"scope","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reflection","declaration":{"id":1413,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1259,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":1258,"name":"SerialPipeline.pipe"}},{"id":1414,"name":"pipe","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/SerialPipeline.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/SerialPipeline.ts#L32"}],"typeParameter":[{"id":1415,"name":"O","variant":"typeParam","kind":131072,"flags":{}}],"parameters":[{"id":1416,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1417,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"}}],"type":{"type":"reference","target":1243,"typeArguments":[{"type":"reflection","declaration":{"id":1418,"name":"__type","variant":"declaration","kind":65536,"flags":{}}},{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":1264,"name":"O","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"},"inheritedFrom":{"type":"reference","target":1263,"name":"SerialPipeline.pipe"}}],"inheritedFrom":{"type":"reference","target":1257,"name":"SerialPipeline.pipe"}},{"id":1400,"name":"run","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WaterfallPipeline.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WaterfallPipeline.ts#L16"}],"signatures":[{"id":1401,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Execute the pipeline in sequential order with the output of each\\nwork unit being passed to the next work unit in the chain."}]},"sources":[{"fileName":"packages/pipeline/src/WaterfallPipeline.ts","line":16,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WaterfallPipeline.ts#L16"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},"overwrites":{"type":"reference","target":1271,"name":"SerialPipeline.run"}}],"overwrites":{"type":"reference","target":1270,"name":"SerialPipeline.run"}}],"groups":[{"title":"Constructors","children":[1392]},{"title":"Properties","children":[1424,1425,1422,1423,1427,1428,1429,1439,1402,1426]},{"title":"Accessors","children":[1434]},{"title":"Methods","children":[1404,1441,1419,1436,1407,1400]}],"categories":[{"title":"Events","children":[1427,1428,1429]},{"title":"__CATEGORY__","children":[1392,1424,1425,1422,1423,1439,1402,1426,1434,1404,1441,1419,1436,1407,1400]}],"sources":[{"fileName":"packages/pipeline/src/WaterfallPipeline.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WaterfallPipeline.ts#L7"}],"typeParameters":[{"id":1451,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1452,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"extendedTypes":[{"type":"reference","target":1243,"typeArguments":[{"type":"reflection","declaration":{"id":1391,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WaterfallPipeline.ts","line":8,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WaterfallPipeline.ts#L8"}]}},{"type":"reference","target":1394,"name":"Ctx","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Ctx","refersToTypeParameter":true},{"type":"reference","target":1395,"name":"Input","package":"@boost/pipeline","qualifiedName":"WaterfallPipeline.Input","refersToTypeParameter":true}],"name":"SerialPipeline","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/WaterfallPipeline","previousId":1300,"nextId":1453},{"id":1453,"name":"WorkUnit","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1454,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L65"}],"signatures":[{"id":1455,"name":"new WorkUnit","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":65,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L65"}],"typeParameter":[{"id":1456,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1457,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1458,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}}],"parameters":[{"id":1459,"name":"title","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1460,"name":"action","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1360,"typeArguments":[{"type":"intrinsic","name":"any"},{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true},{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}],"name":"Action","package":"@boost/pipeline"}},{"id":1461,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true},{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true},{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}],"name":"WorkUnit","package":"@boost/pipeline"},"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":1462,"name":"depth","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current depth of nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":18,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L18"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","implementationOf":{"type":"reference","target":1374,"name":"Hierarchical.depth"}},{"id":1463,"name":"index","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current index amongst sibling work units."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L20"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0","implementationOf":{"type":"reference","target":1376,"name":"Hierarchical.index"}},{"id":1465,"name":"input","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L24"}],"type":{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}},{"id":1469,"name":"onFail","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution fails."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":36,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"union","types":[{"type":"literal","value":null},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}]},{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1470,"name":"onPass","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution succeeds."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":42,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L42"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true},{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1471,"name":"onRun","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a work unit is executed. Can return "},{"kind":"code","text":"`true`"},{"kind":"text","text":" to skip the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":48,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L48"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/BailEvent.ts","qualifiedName":"BailEvent"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"BailEvent","package":"@boost/event"},"defaultValue":"..."},{"id":1472,"name":"onSkip","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called when an execution is skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":54,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L54"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1497,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":1464,"name":"output","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L22"}],"type":{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}},{"id":1466,"name":"startTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":26,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L26"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0"},{"id":1467,"name":"statusText","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L28"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"\'\'"},{"id":1468,"name":"stopTime","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L30"}],"type":{"type":"intrinsic","name":"number"},"defaultValue":"0"},{"id":1473,"name":"title","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":56,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L56"}],"type":{"type":"intrinsic","name":"string"}},{"id":1476,"name":"id","variant":"declaration","kind":262144,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique ID of the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"getSignature":{"id":1477,"name":"id","variant":"signature","kind":524288,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a unique hierarchical ID."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":84,"character":5,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L84"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":1375,"name":"Hierarchical.id"}},"implementationOf":{"type":"reference","target":1375,"name":"Hierarchical.id"}},{"id":1504,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"signatures":[{"id":1505,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"parameters":[{"id":1506,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":1507,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":1498,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1499,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1500,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1501,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1502,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1503,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":1478,"name":"hasFailed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"signatures":[{"id":1479,"name":"hasFailed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task failed when executing."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":91,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L91"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1480,"name":"hasPassed","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"signatures":[{"id":1481,"name":"hasPassed","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task executed successfully."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":98,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L98"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1482,"name":"isComplete","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"signatures":[{"id":1483,"name":"isComplete","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has been completed in any form."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":105,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L105"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1484,"name":"isPending","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"signatures":[{"id":1485,"name":"isPending","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task has not been executed yet."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":112,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L112"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1486,"name":"isRunning","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"signatures":[{"id":1487,"name":"isRunning","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task is currently running."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":119,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L119"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1488,"name":"isSkipped","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"signatures":[{"id":1489,"name":"isSkipped","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if the task was or will be skipped."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":126,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L126"}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1490,"name":"run","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"signatures":[{"id":1491,"name":"run","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Run the current task by executing it and performing any before and after processes."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":133,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L133"}],"parameters":[{"id":1492,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1493,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},"implementationOf":{"type":"reference","target":1378,"name":"Runnable.run"}}],"implementationOf":{"type":"reference","target":1378,"name":"Runnable.run"}},{"id":1494,"name":"skip","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"signatures":[{"id":1495,"name":"skip","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Mark a task as skipped if the condition is true."}]},"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":175,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L175"}],"parameters":[{"id":1496,"name":"condition","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"true"}],"type":{"type":"intrinsic","name":"this"}}]}],"groups":[{"title":"Constructors","children":[1454]},{"title":"Properties","children":[1462,1463,1465,1469,1470,1471,1472,1497,1464,1466,1467,1468,1473]},{"title":"Accessors","children":[1476]},{"title":"Methods","children":[1504,1498,1478,1480,1482,1484,1486,1488,1490,1494]}],"categories":[{"title":"Events","children":[1469,1470,1471,1472]},{"title":"__CATEGORY__","children":[1454,1462,1463,1465,1497,1464,1466,1467,1468,1473,1476,1504,1498,1478,1480,1482,1484,1486,1488,1490,1494]}],"sources":[{"fileName":"packages/pipeline/src/WorkUnit.ts","line":14,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/WorkUnit.ts#L14"}],"typeParameters":[{"id":1508,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"}},{"id":1509,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1510,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":1456,"name":"Options","package":"@boost/pipeline","qualifiedName":"WorkUnit.Options","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}],"extendedBy":[{"type":"reference","target":1135,"name":"Routine"},{"type":"reference","target":1300,"name":"Task"}],"implementedTypes":[{"type":"reference","target":1377,"typeArguments":[{"type":"reference","target":1457,"name":"Input","package":"@boost/pipeline","qualifiedName":"WorkUnit.Input","refersToTypeParameter":true},{"type":"reference","target":1458,"name":"Output","package":"@boost/pipeline","qualifiedName":"WorkUnit.Output","refersToTypeParameter":true}],"name":"Runnable","package":"@boost/pipeline"},{"type":"reference","target":1373,"name":"Hierarchical","package":"@boost/pipeline"}],"permalink":"/api/pipeline/class/WorkUnit","previousId":1390,"nextId":1369},{"id":1369,"name":"AggregatedResult","variant":"declaration","kind":256,"flags":{},"children":[{"id":1370,"name":"errors","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of "},{"kind":"code","text":"`Errors`"},{"kind":"text","text":" that occurred during execution."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L13"}],"type":{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"}}},{"id":1371,"name":"results","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"List of successful execution results."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L15"}],"type":{"type":"array","elementType":{"type":"reference","target":1372,"name":"T","package":"@boost/pipeline","qualifiedName":"AggregatedResult.T","refersToTypeParameter":true}}}],"groups":[{"title":"Properties","children":[1370,1371]}],"sources":[{"fileName":"packages/pipeline/src/types.ts","line":11,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L11"}],"typeParameters":[{"id":1372,"name":"T","variant":"typeParam","kind":131072,"flags":{}}],"permalink":"/api/pipeline/interface/AggregatedResult","previousId":1453,"nextId":1129},{"id":1129,"name":"ExecuteCommandOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1134,"name":"workUnit","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L21"}],"type":{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"}},{"id":1130,"name":"wrap","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L20"}],"type":{"type":"reflection","declaration":{"id":1131,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":20,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L20"}],"signatures":[{"id":1132,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":20,"character":8,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L20"}],"parameters":[{"id":1133,"name":"process","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/execa/index.d.ts","qualifiedName":"ExecaChildProcess"},"name":"ExecaChildProcess","package":"execa"}}],"type":{"type":"intrinsic","name":"void"}}]}}}],"groups":[{"title":"Properties","children":[1134,1130]}],"sources":[{"fileName":"packages/pipeline/src/Routine.ts","line":19,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/Routine.ts#L19"}],"permalink":"/api/pipeline/interface/ExecuteCommandOptions","previousId":1369,"nextId":1373},{"id":1373,"name":"Hierarchical","variant":"declaration","kind":256,"flags":{},"children":[{"id":1374,"name":"depth","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current depth of nested pipelines."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L20"}],"type":{"type":"intrinsic","name":"number"}},{"id":1375,"name":"id","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique ID of the work unit."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":22,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L22"}],"type":{"type":"intrinsic","name":"string"}},{"id":1376,"name":"index","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Current index amongst sibling work units."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":24,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L24"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[1374,1375,1376]}],"sources":[{"fileName":"packages/pipeline/src/types.ts","line":18,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L18"}],"implementedBy":[{"type":"reference","target":1453,"name":"WorkUnit"}],"permalink":"/api/pipeline/interface/Hierarchical","previousId":1129,"nextId":1059},{"id":1059,"name":"PooledOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1060,"name":"concurrency","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"How many work units to process in parallel."}]},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L15"}],"type":{"type":"intrinsic","name":"number"}},{"id":1061,"name":"filo","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Process with first-in-last-out order, instead of first-in-first-out."}]},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L17"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1062,"name":"timeout","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Timeout in milliseconds that each work unit may run, or "},{"kind":"code","text":"`0`"},{"kind":"text","text":" to avoid a\\ntimeout. Defaults to "},{"kind":"code","text":"`0`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":20,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L20"}],"type":{"type":"intrinsic","name":"number"}}],"groups":[{"title":"Properties","children":[1060,1061,1062]}],"sources":[{"fileName":"packages/pipeline/src/PooledPipeline.ts","line":13,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PooledPipeline.ts#L13"}],"permalink":"/api/pipeline/interface/PooledOptions","previousId":1373,"nextId":1377},{"id":1377,"name":"Runnable","variant":"declaration","kind":256,"flags":{},"children":[{"id":1378,"name":"run","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L29"}],"type":{"type":"reflection","declaration":{"id":1379,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":29,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L29"}],"signatures":[{"id":1380,"name":"__type","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Accept an input and produce an output."}]},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":29,"character":6,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L29"}],"parameters":[{"id":1381,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1382,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1383,"name":"Input","package":"@boost/pipeline","qualifiedName":"Runnable.Input","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1384,"name":"Output","package":"@boost/pipeline","qualifiedName":"Runnable.Output","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]}}}],"groups":[{"title":"Properties","children":[1378]}],"sources":[{"fileName":"packages/pipeline/src/types.ts","line":27,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L27"}],"typeParameters":[{"id":1383,"name":"Input","variant":"typeParam","kind":131072,"flags":{}},{"id":1384,"name":"Output","variant":"typeParam","kind":131072,"flags":{}}],"implementedBy":[{"type":"reference","target":1453,"name":"WorkUnit"}],"permalink":"/api/pipeline/interface/Runnable","previousId":1059,"nextId":1360},{"id":1360,"name":"Action","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L5"}],"typeParameters":[{"id":1366,"name":"Ctx","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"}},{"id":1367,"name":"Input","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1368,"name":"Output","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"reference","target":1367,"name":"Input","package":"@boost/pipeline","refersToTypeParameter":true}}],"type":{"type":"reflection","declaration":{"id":1361,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":5,"character":75,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L5"}],"signatures":[{"id":1362,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":1363,"name":"context","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1366,"name":"Ctx","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1364,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1367,"name":"Input","package":"@boost/pipeline","refersToTypeParameter":true}},{"id":1365,"name":"workUnit","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1388,"name":"AnyWorkUnit","package":"@boost/pipeline"}}],"type":{"type":"union","types":[{"type":"reference","target":1368,"name":"Output","package":"@boost/pipeline","refersToTypeParameter":true},{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1368,"name":"Output","package":"@boost/pipeline","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}]}}]}},"permalink":"/api/pipeline#Action","previousId":1377,"nextId":1386},{"id":1386,"name":"AnyPipeline","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":36,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L36"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/pipeline/src/Pipeline.ts","qualifiedName":"Pipeline"},"typeArguments":[{"type":"reflection","declaration":{"id":1387,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":36,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L36"}]}},{"type":"reference","target":977,"name":"Context","package":"@boost/pipeline"},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"Pipeline","package":"@boost/pipeline"},"permalink":"/api/pipeline#AnyPipeline","previousId":1360,"nextId":1388},{"id":1388,"name":"AnyWorkUnit","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":40,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L40"}],"type":{"type":"reference","target":1453,"typeArguments":[{"type":"reflection","declaration":{"id":1389,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":40,"character":35,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L40"}]}},{"type":"intrinsic","name":"any"},{"type":"intrinsic","name":"any"}],"name":"WorkUnit","package":"@boost/pipeline"},"permalink":"/api/pipeline#AnyWorkUnit","previousId":1386,"nextId":1053},{"id":1053,"name":"PipelineErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/PipelineError.ts","line":11,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PipelineError.ts#L11"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/pipeline/src/PipelineError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/pipeline","preferValues":true}}},"permalink":"/api/pipeline#PipelineErrorCode","previousId":1388,"nextId":1385},{"id":1385,"name":"Status","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/pipeline/src/types.ts","line":32,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/types.ts#L32"}],"type":{"type":"union","types":[{"type":"literal","value":"failed"},{"type":"literal","value":"passed"},{"type":"literal","value":"pending"},{"type":"literal","value":"running"},{"type":"literal","value":"skipped"}]},"permalink":"/api/pipeline#Status","previousId":1053,"nextId":1054},{"id":1054,"name":"PipelineError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/PipelineError.ts","line":13,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/PipelineError.ts#L13"}],"type":{"type":"reflection","declaration":{"id":1055,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":1056,"name":"new PipelineError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":1057,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"ACTION_REQUIRED"},{"type":"literal","value":"ROUTINE_INVALID_KEY"},{"type":"literal","value":"WORK_REQUIRED_TITLE"},{"type":"literal","value":"WORK_TIME_OUT"},{"type":"literal","value":"WORK_UNKNOWN"}]}},{"id":1058,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"ACTION_REQUIRED"},{"type":"literal","value":"ROUTINE_INVALID_KEY"},{"type":"literal","value":"WORK_REQUIRED_TITLE"},{"type":"literal","value":"WORK_TIME_OUT"},{"type":"literal","value":"WORK_UNKNOWN"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/pipeline#PipelineError","previousId":1385,"nextId":976},{"id":976,"name":"STATUS_FAILED","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L7"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'failed\'","permalink":"/api/pipeline#STATUS_FAILED","previousId":1054,"nextId":975},{"id":975,"name":"STATUS_PASSED","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":6,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L6"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'passed\'","permalink":"/api/pipeline#STATUS_PASSED","previousId":976,"nextId":972},{"id":972,"name":"STATUS_PENDING","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":3,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L3"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'pending\'","permalink":"/api/pipeline#STATUS_PENDING","previousId":975,"nextId":973},{"id":973,"name":"STATUS_RUNNING","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L4"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'running\'","permalink":"/api/pipeline#STATUS_RUNNING","previousId":972,"nextId":974},{"id":974,"name":"STATUS_SKIPPED","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/pipeline/src/constants.ts","line":5,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/constants.ts#L5"}],"type":{"type":"reference","target":1385,"name":"Status","package":"@boost/pipeline"},"defaultValue":"\'skipped\'","permalink":"/api/pipeline#STATUS_SKIPPED","previousId":973}],"groups":[{"title":"Classes","children":[848,910,977,983,996,1063,1135,1243,1300,1390,1453]},{"title":"Interfaces","children":[1369,1129,1373,1059,1377]},{"title":"Type Aliases","children":[1360,1386,1388,1053,1385]},{"title":"Variables","children":[1054,976,975,972,973,974]}],"sources":[{"fileName":"packages/pipeline/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/pipeline/src/index.ts#L1"}],"permalink":"/api/pipeline"},"urlSlug":"pipeline"}],"packageName":"@boost/pipeline","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":6,"name":"@boost/plugin","variant":"declaration","kind":2,"flags":{},"children":[{"id":1512,"name":"Plugin","variant":"declaration","kind":128,"flags":{"isAbstract":true},"children":[{"id":1513,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":6,"character":4}],"signatures":[{"id":1514,"name":"new Plugin","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":6,"character":4}],"typeParameter":[{"id":1515,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1516,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1517,"name":"__type","variant":"declaration","kind":65536,"flags":{}}}}],"parameters":[{"id":1518,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}}],"type":{"type":"reference","target":1512,"typeArguments":[{"type":"reference","target":1515,"name":"T","package":"@boost/plugin","qualifiedName":"Plugin.T","refersToTypeParameter":true},{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Plugin","package":"@boost/plugin"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.constructor"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.constructor"}},{"id":1519,"name":"name","variant":"declaration","kind":1024,"flags":{"isAbstract":true},"comment":{"summary":[{"kind":"text","text":"Unique name of the plugin. Typically the npm package name."}]},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":8,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L8"}],"type":{"type":"intrinsic","name":"string"},"implementationOf":{"type":"reference","target":1633,"name":"Pluggable.name"}},{"id":1526,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":1533,"name":"blueprint","variant":"declaration","kind":2048,"flags":{"isAbstract":true},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"signatures":[{"id":1534,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Define an "},{"kind":"code","text":"`optimal`"},{"kind":"text","text":" blueprint in which to validate and build the\\noptions object passed to the constructor, or when manual setting.\\n\\nA boolean is passed as the 2nd argument to determine whether this is\\nvalidating on class instantiation (first time), or by calling\\n"},{"kind":"code","text":"`configure()`"},{"kind":"text","text":" (all other times)."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":32,"character":13}],"parameters":[{"id":1535,"name":"_schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}},{"id":1536,"name":"onConstruction","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"boolean"}}],"type":{"type":"intrinsic","name":"object"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":1527,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1528,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1529,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1530,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1531,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1532,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":1523,"name":"shutdown","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Life cycle called when the plugin is unregistered."}]},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L12"}],"signatures":[{"id":1524,"name":"shutdown","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":12,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L12"}],"parameters":[{"id":1525,"name":"tool","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1515,"name":"T","package":"@boost/plugin","qualifiedName":"Plugin.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"},"implementationOf":{"type":"reference","target":-1,"name":"Pluggable.shutdown"}}],"implementationOf":{"type":"reference","target":1635,"name":"Pluggable.shutdown"}},{"id":1520,"name":"startup","variant":"declaration","kind":2048,"flags":{},"comment":{"summary":[{"kind":"text","text":"Life cycle called when the plugin is registered."}]},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L10"}],"signatures":[{"id":1521,"name":"startup","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":10,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L10"}],"parameters":[{"id":1522,"name":"tool","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1515,"name":"T","package":"@boost/plugin","qualifiedName":"Plugin.T","refersToTypeParameter":true}}],"type":{"type":"intrinsic","name":"void"},"implementationOf":{"type":"reference","target":-1,"name":"Pluggable.startup"}}],"implementationOf":{"type":"reference","target":1636,"name":"Pluggable.startup"}}],"groups":[{"title":"Constructors","children":[1513]},{"title":"Properties","children":[1519,1526]},{"title":"Methods","children":[1533,1527,1523,1520]}],"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":4,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L4"}],"typeParameters":[{"id":1537,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}},{"id":1538,"name":"Options","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"reflection","declaration":{"id":1539,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/plugin/src/Plugin.ts","line":4,"character":67,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Plugin.ts#L4"}]}}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":1516,"name":"Options","package":"@boost/plugin","qualifiedName":"Plugin.Options","refersToTypeParameter":true}],"name":"Contract","package":"@boost/common"}],"implementedTypes":[{"type":"reference","target":1632,"typeArguments":[{"type":"reference","target":1515,"name":"T","package":"@boost/plugin","qualifiedName":"Plugin.T","refersToTypeParameter":true}],"name":"Pluggable","package":"@boost/plugin"}],"permalink":"/api/plugin/class/Plugin","nextId":1546},{"id":1546,"name":"Registry","variant":"declaration","kind":128,"flags":{},"children":[{"id":1547,"name":"constructor","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":75,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L75"}],"signatures":[{"id":1548,"name":"new Registry","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":75,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L75"}],"typeParameter":[{"id":1549,"name":"Plugin","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Pluggable","package":"@boost/plugin"}},{"id":1550,"name":"Tool","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"parameters":[{"id":1551,"name":"projectName","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1552,"name":"typeName","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1553,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}}],"type":{"type":"reference","target":1546,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true},{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}],"name":"Registry","package":"@boost/plugin"},"overwrites":{"type":"reference","target":-1,"name":"Contract<\\n\\tRegistryOptions\\n>.constructor"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract<\\n\\tRegistryOptions\\n>.constructor"}},{"id":1554,"name":"debug","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":33,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L33"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/debug/src/types.ts","qualifiedName":"Debugger"},"name":"Debugger","package":"@boost/debug"}},{"id":1555,"name":"onAfterRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a plugin is registered."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":39,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L39"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1556,"name":"onAfterUnregister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a plugin is unregistered."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":45,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L45"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1557,"name":"onBeforeRegister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a plugin is registered and the "},{"kind":"code","text":"`startup`"},{"kind":"text","text":" life-cycle."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":51,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L51"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1558,"name":"onBeforeUnregister","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called before a plugin is unregistered and the "},{"kind":"code","text":"`shutdown`"},{"kind":"text","text":" life-cycle."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":57,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L57"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1559,"name":"onLoad","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Called after a plugin is loaded but before it\'s registered."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":63,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L63"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/event/src/Event.ts","qualifiedName":"Event"},"typeArguments":[{"type":"tuple","elements":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"object"}]},{"type":"intrinsic","name":"string"}],"name":"Event","package":"@boost/event"},"defaultValue":"..."},{"id":1615,"name":"options","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Validated and configured options."}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":5,"character":13}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.options"}},{"id":1560,"name":"pluralName","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":65,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L65"}],"type":{"type":"intrinsic","name":"string"}},{"id":1561,"name":"projectName","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":67,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L67"}],"type":{"type":"intrinsic","name":"string"}},{"id":1562,"name":"singularName","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":69,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L69"}],"type":{"type":"intrinsic","name":"string"}},{"id":1565,"name":"blueprint","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":89,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L89"}],"signatures":[{"id":1566,"name":"blueprint","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":89,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L89"}],"parameters":[{"id":1567,"name":"schemas","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/schemas/index.d.ts","qualifiedName":""},"name":"__module","package":"optimal"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/optimal/dts/types.d.ts","qualifiedName":"Blueprint"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Blueprint","package":"optimal"},"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}}],"overwrites":{"type":"reference","target":-1,"name":"Contract.blueprint"}},{"id":1616,"name":"configure","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"signatures":[{"id":1617,"name":"configure","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set an options object by merging the new partial and existing options\\nwith the defined blueprint, while running all validation checks.\\nFreeze and return the options object.\\n\\n"},{"kind":"code","text":"```ts\\nobject.configure({ name: \'Boost\' });\\n\\nobject.configure((prevOptions) => ({\\n\\tnestedObject: {\\n\\t\\t...prevOptions.nestedObject,\\n\\t\\tsome: \'value\',\\n\\t},\\n}));\\n```"}]},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":4}],"parameters":[{"id":1618,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Partial","package":"typescript"},{"type":"reflection","declaration":{"id":1619,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"signatures":[{"id":1620,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/common/mjs/Contract.d.ts","line":23,"character":38}],"parameters":[{"id":1621,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Required","package":"typescript"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Partial","package":"typescript"}}]}}]}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Readonly"},"typeArguments":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Required"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Required","package":"typescript"}],"name":"Readonly","package":"typescript"},"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}}],"inheritedFrom":{"type":"reference","target":-1,"name":"Contract.configure"}},{"id":1568,"name":"formatModuleName","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":106,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L106"}],"signatures":[{"id":1569,"name":"formatModuleName","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Format a name into a fully qualified and compatible Node/npm module name,\\nwith the tool and type names being used as scopes and prefixes."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":106,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L106"}],"parameters":[{"id":1570,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1571,"name":"scoped","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"boolean"},"defaultValue":"false"}],"type":{"type":"intrinsic","name":"string"}}]},{"id":1572,"name":"get","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L118"}],"signatures":[{"id":1573,"name":"get","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return a single registered plugin by module name. If the plugin cannot be found,\\nan error will be thrown."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":118,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L118"}],"typeParameter":[{"id":1574,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"typeArguments":[{"type":"intrinsic","name":"any"}],"name":"Pluggable","package":"@boost/plugin"},"default":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}}],"parameters":[{"id":1575,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":1574,"name":"T","package":"@boost/plugin","refersToTypeParameter":true}}]},{"id":1576,"name":"getAll","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":131,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L131"}],"signatures":[{"id":1577,"name":"getAll","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return all registered plugins."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":131,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L131"}],"type":{"type":"array","elementType":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}}}]},{"id":1578,"name":"getMany","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":138,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L138"}],"signatures":[{"id":1579,"name":"getMany","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return multiple registered plugins by module name."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":138,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L138"}],"parameters":[{"id":1580,"name":"names","variant":"param","kind":32768,"flags":{},"type":{"type":"array","elementType":{"type":"intrinsic","name":"string"}}}],"type":{"type":"array","elementType":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}}}]},{"id":1590,"name":"isRegistered","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":214,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L214"}],"signatures":[{"id":1591,"name":"isRegistered","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Return true if a plugin has been registered."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":214,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L214"}],"parameters":[{"id":1592,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}]},{"id":1581,"name":"load","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":145,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L145"}],"signatures":[{"id":1582,"name":"load","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Load and register a single plugin by name, or with an explicit instance."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":145,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L145"}],"parameters":[{"id":1583,"name":"source","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}]}},{"id":1584,"name":"params","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"object"},"defaultValue":"{}"},{"id":1585,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1645,"typeArguments":[{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}],"name":"RegisterOptions","package":"@boost/plugin"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]},{"id":1586,"name":"loadMany","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":182,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L182"}],"signatures":[{"id":1587,"name":"loadMany","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Load and register multiple plugins based on a list of settings."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":182,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L182"}],"parameters":[{"id":1588,"name":"settings","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":1638,"name":"Setting","package":"@boost/plugin"},{"type":"array","elementType":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true},{"type":"reference","target":1626,"name":"SourceWithOptions","package":"@boost/plugin"}]}}]}},{"id":1589,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1645,"typeArguments":[{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}],"name":"RegisterOptions","package":"@boost/plugin"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"array","elementType":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}}],"name":"Promise","package":"typescript"}}]},{"id":1593,"name":"register","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":227,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L227"}],"signatures":[{"id":1594,"name":"register","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Register a plugin and trigger startup with the provided tool."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":227,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L227"}],"parameters":[{"id":1595,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1596,"name":"plugin","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}},{"id":1597,"name":"tool","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"undefined"},{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}]},"defaultValue":"undefined"},{"id":1598,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1645,"typeArguments":[{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}],"name":"RegisterOptions","package":"@boost/plugin"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]},{"id":1599,"name":"unregister","variant":"declaration","kind":2048,"flags":{},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":271,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L271"}],"signatures":[{"id":1600,"name":"unregister","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unregister a plugin by name and trigger shutdown process."}]},"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":271,"character":7,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L271"}],"parameters":[{"id":1601,"name":"name","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1602,"name":"tool","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1550,"name":"Tool","package":"@boost/plugin","qualifiedName":"Registry.Tool","refersToTypeParameter":true}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"Promise","package":"typescript"}}]}],"groups":[{"title":"Constructors","children":[1547]},{"title":"Properties","children":[1554,1555,1556,1557,1558,1559,1615,1560,1561,1562]},{"title":"Methods","children":[1565,1616,1568,1572,1576,1578,1590,1581,1586,1593,1599]}],"categories":[{"title":"Events","children":[1555,1556,1557,1558,1559]},{"title":"__CATEGORY__","children":[1547,1554,1615,1560,1561,1562,1565,1616,1568,1572,1576,1578,1590,1581,1586,1593,1599]}],"sources":[{"fileName":"packages/plugin/src/Registry.ts","line":30,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/Registry.ts#L30"}],"typeParameters":[{"id":1622,"name":"Plugin","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"name":"Pluggable","package":"@boost/plugin"}},{"id":1623,"name":"Tool","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"extendedTypes":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/Contract.ts","qualifiedName":"Contract"},"typeArguments":[{"type":"reference","target":1655,"typeArguments":[{"type":"reference","target":1549,"name":"Plugin","package":"@boost/plugin","qualifiedName":"Registry.Plugin","refersToTypeParameter":true}],"name":"RegistryOptions","package":"@boost/plugin"}],"name":"Contract","package":"@boost/common"}],"permalink":"/api/plugin/class/Registry","previousId":1512,"nextId":1632},{"id":1632,"name":"Pluggable","variant":"declaration","kind":256,"flags":{},"children":[{"id":1633,"name":"name","variant":"declaration","kind":1024,"flags":{"isReadonly":true},"comment":{"summary":[{"kind":"text","text":"Unique name of the plugin. Typically the npm package name."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":15,"character":10,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"string"}},{"id":1634,"name":"priority","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Priority in which to order the plugin."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L17"}],"type":{"type":"intrinsic","name":"number"}},{"id":1635,"name":"shutdown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Life cycle called when the plugin is unregistered."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L19"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1637,"name":"T","package":"@boost/plugin","qualifiedName":"Pluggable.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1636,"name":"startup","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Life cycle called when the plugin is registered."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L21"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1637,"name":"T","package":"@boost/plugin","qualifiedName":"Pluggable.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}}],"groups":[{"title":"Properties","children":[1633,1634,1635,1636]}],"sources":[{"fileName":"packages/plugin/src/types.ts","line":13,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L13"}],"typeParameters":[{"id":1637,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"any"}}],"implementedBy":[{"type":"reference","target":1512,"name":"Plugin"}],"permalink":"/api/plugin/interface/Pluggable","previousId":1546,"nextId":1645},{"id":1645,"name":"RegisterOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1646,"name":"priority","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Override the priority of the plugin."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L32"}],"type":{"type":"intrinsic","name":"number"}},{"id":1647,"name":"tool","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom tool instance to pass to life cycles."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L34"}],"type":{"type":"reference","target":1648,"name":"T","package":"@boost/plugin","qualifiedName":"RegisterOptions.T","refersToTypeParameter":true}}],"groups":[{"title":"Properties","children":[1646,1647]}],"sources":[{"fileName":"packages/plugin/src/types.ts","line":30,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L30"}],"typeParameters":[{"id":1648,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"extendedBy":[{"type":"reference","target":1649,"name":"Registration"}],"permalink":"/api/plugin/interface/RegisterOptions","previousId":1632,"nextId":1649},{"id":1649,"name":"Registration","variant":"declaration","kind":256,"flags":{},"children":[{"id":1650,"name":"name","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Unique name of the plugin."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":39,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L39"}],"type":{"type":"intrinsic","name":"string"}},{"id":1651,"name":"plugin","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Plugin instance or object."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":41,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L41"}],"type":{"type":"reference","target":1654,"name":"T","package":"@boost/plugin","qualifiedName":"Registration.T","refersToTypeParameter":true}},{"id":1652,"name":"priority","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Override the priority of the plugin."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":32,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L32"}],"type":{"type":"intrinsic","name":"number"},"inheritedFrom":{"type":"reference","target":1646,"name":"RegisterOptions.priority"}},{"id":1653,"name":"tool","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom tool instance to pass to life cycles."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":34,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L34"}],"type":{"type":"intrinsic","name":"unknown"},"inheritedFrom":{"type":"reference","target":1647,"name":"RegisterOptions.tool"}}],"groups":[{"title":"Properties","children":[1650,1651,1652,1653]}],"sources":[{"fileName":"packages/plugin/src/types.ts","line":37,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L37"}],"typeParameters":[{"id":1654,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"name":"Pluggable","package":"@boost/plugin"}}],"extendedTypes":[{"type":"reference","target":1645,"name":"RegisterOptions","package":"@boost/plugin"}],"permalink":"/api/plugin/interface/Registration","previousId":1645,"nextId":1655},{"id":1655,"name":"RegistryOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1656,"name":"afterShutdown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback fired after a plugin\'s "},{"kind":"code","text":"`shutdown`"},{"kind":"text","text":" life cycle is executed."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":46,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L46"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1657,"name":"afterStartup","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback fired after a plugin\'s "},{"kind":"code","text":"`startup`"},{"kind":"text","text":" life cycle is executed."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":48,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L48"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1658,"name":"beforeShutdown","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback fired before a plugin\'s "},{"kind":"code","text":"`shutdown`"},{"kind":"text","text":" life cycle is executed."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":50,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L50"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1659,"name":"beforeStartup","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Callback fired before a plugin\'s "},{"kind":"code","text":"`startup`"},{"kind":"text","text":" life cycle is executed."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":52,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L52"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}},{"id":1660,"name":"resolver","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Custom module resolver."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":54,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L54"}],"type":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"ModuleResolver"},"name":"ModuleResolver","package":"@boost/common"}},{"id":1661,"name":"validate","variant":"declaration","kind":1024,"flags":{},"comment":{"summary":[{"kind":"text","text":"Validate the shape of the plugin being registered."}]},"sources":[{"fileName":"packages/plugin/src/types.ts","line":56,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L56"}],"type":{"type":"reference","target":1627,"typeArguments":[{"type":"reference","target":1662,"name":"T","package":"@boost/plugin","qualifiedName":"RegistryOptions.T","refersToTypeParameter":true}],"name":"Callback","package":"@boost/plugin"}}],"groups":[{"title":"Properties","children":[1656,1657,1658,1659,1660,1661]}],"sources":[{"fileName":"packages/plugin/src/types.ts","line":44,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L44"}],"typeParameters":[{"id":1662,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"name":"Pluggable","package":"@boost/plugin"}}],"permalink":"/api/plugin/interface/RegistryOptions","previousId":1649,"nextId":1627},{"id":1627,"name":"Callback","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":9,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L9"}],"typeParameters":[{"id":1631,"name":"T","variant":"typeParam","kind":131072,"flags":{},"default":{"type":"intrinsic","name":"unknown"}}],"type":{"type":"reflection","declaration":{"id":1628,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":9,"character":36,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L9"}],"signatures":[{"id":1629,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":1630,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1631,"name":"T","package":"@boost/plugin","refersToTypeParameter":true}}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"},{"type":"intrinsic","name":"void"}]}}]}},"permalink":"/api/plugin#Callback","previousId":1655,"nextId":1639},{"id":1639,"name":"Factory","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":26,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L26"}],"typeParameters":[{"id":1643,"name":"T","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"reference","target":1632,"name":"Pluggable","package":"@boost/plugin"}},{"id":1644,"name":"O","variant":"typeParam","kind":131072,"flags":{},"type":{"type":"intrinsic","name":"object"},"default":{"type":"intrinsic","name":"object"}}],"type":{"type":"reflection","declaration":{"id":1640,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":26,"character":70,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L26"}],"signatures":[{"id":1641,"name":"__type","variant":"signature","kind":4096,"flags":{},"parameters":[{"id":1642,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Partial"},"typeArguments":[{"type":"reference","target":1644,"name":"O","package":"@boost/plugin","refersToTypeParameter":true}],"name":"Partial","package":"typescript"}}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1643,"name":"T","package":"@boost/plugin","refersToTypeParameter":true}],"name":"Promise","package":"typescript"},{"type":"reference","target":1643,"name":"T","package":"@boost/plugin","refersToTypeParameter":true}]}}]}},"permalink":"/api/plugin#Factory","previousId":1627,"nextId":1540},{"id":1540,"name":"PluginErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/PluginError.ts","line":13,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/PluginError.ts#L13"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/plugin/src/PluginError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/plugin","preferValues":true}}},"permalink":"/api/plugin#PluginErrorCode","previousId":1639,"nextId":1638},{"id":1638,"name":"Setting","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":24,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L24"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"reference","target":1625,"name":"SourceOptions","package":"@boost/plugin"}],"name":"Record","package":"typescript"},"permalink":"/api/plugin#Setting","previousId":1540,"nextId":1624},{"id":1624,"name":"Source","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L3"}],"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"FilePath"},"name":"FilePath","package":"@boost/common"},{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"ModuleID"},"name":"ModuleID","package":"@boost/common"}]},"permalink":"/api/plugin#Source","previousId":1638,"nextId":1625},{"id":1625,"name":"SourceOptions","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L5"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"boolean"},{"type":"intrinsic","name":"object"}]},"permalink":"/api/plugin#SourceOptions","previousId":1624,"nextId":1626},{"id":1626,"name":"SourceWithOptions","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/plugin/src/types.ts","line":7,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/types.ts#L7"}],"type":{"type":"tuple","elements":[{"type":"reference","target":1624,"name":"Source","package":"@boost/plugin"},{"type":"reference","target":1625,"name":"SourceOptions","package":"@boost/plugin"}]},"permalink":"/api/plugin#SourceWithOptions","previousId":1625,"nextId":1511},{"id":1511,"name":"DEFAULT_PRIORITY","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/plugin/src/constants.ts","line":1,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/constants.ts#L1"}],"type":{"type":"literal","value":100},"defaultValue":"100","permalink":"/api/plugin#DEFAULT_PRIORITY","previousId":1626,"nextId":1541},{"id":1541,"name":"PluginError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/plugin/src/PluginError.ts","line":15,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/PluginError.ts#L15"}],"type":{"type":"reflection","declaration":{"id":1542,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":1543,"name":"new PluginError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":1544,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"FACTORY_REQUIRED"},{"type":"literal","value":"MODULE_NAME_INVALID"},{"type":"literal","value":"MODULE_UNKNOWN_FORMAT"},{"type":"literal","value":"PLUGIN_REQUIRED"},{"type":"literal","value":"PLUGIN_REQUIRED_NAME"},{"type":"literal","value":"REGISTER_REQUIRED"},{"type":"literal","value":"SETTING_UNKNOWN"}]}},{"id":1545,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"FACTORY_REQUIRED"},{"type":"literal","value":"MODULE_NAME_INVALID"},{"type":"literal","value":"MODULE_UNKNOWN_FORMAT"},{"type":"literal","value":"PLUGIN_REQUIRED"},{"type":"literal","value":"PLUGIN_REQUIRED_NAME"},{"type":"literal","value":"REGISTER_REQUIRED"},{"type":"literal","value":"SETTING_UNKNOWN"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/plugin#PluginError","previousId":1511}],"groups":[{"title":"Classes","children":[1512,1546]},{"title":"Interfaces","children":[1632,1645,1649,1655]},{"title":"Type Aliases","children":[1627,1639,1540,1638,1624,1625,1626]},{"title":"Variables","children":[1511,1541]}],"sources":[{"fileName":"packages/plugin/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/plugin/src/index.ts#L1"}],"permalink":"/api/plugin"},"urlSlug":"plugin"}],"packageName":"@boost/plugin","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":7,"name":"@boost/terminal","variant":"declaration","kind":2,"flags":{},"children":[{"id":1663,"name":"cursor","variant":"declaration","kind":4,"flags":{},"children":[{"id":1673,"name":"hide","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Hide the cursor."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":13,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L13"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorHide","permalink":"/api/terminal/namespace/cursor#hide"},{"id":1674,"name":"nextLine","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Move cursor to the next line."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":16,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L16"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorNextLine","permalink":"/api/terminal/namespace/cursor#nextLine"},{"id":1675,"name":"position","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Return the current cursur position."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":19,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L19"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorGetPosition","permalink":"/api/terminal/namespace/cursor#position"},{"id":1676,"name":"prevLine","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Move cursor to the previous line."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":22,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L22"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorPrevLine","permalink":"/api/terminal/namespace/cursor#prevLine"},{"id":1677,"name":"restorePosition","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Restores the cursor position/state."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":25,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L25"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorRestorePosition","permalink":"/api/terminal/namespace/cursor#restorePosition"},{"id":1678,"name":"savePosition","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Saves the cursor position/state."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":28,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L28"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorSavePosition","permalink":"/api/terminal/namespace/cursor#savePosition"},{"id":1679,"name":"show","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Show the cursor."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":31,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L31"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorShow","permalink":"/api/terminal/namespace/cursor#show"},{"id":1680,"name":"startLine","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Move cursor to the start of the current line."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":34,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L34"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.cursorLeft","permalink":"/api/terminal/namespace/cursor#startLine"},{"id":1664,"name":"backward","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L4"}],"signatures":[{"id":1665,"name":"backward","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of columns to move backward. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":4,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L4"}],"parameters":[{"id":1666,"name":"count","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#backward"},{"id":1667,"name":"down","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L7"}],"signatures":[{"id":1668,"name":"down","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of rows to move down. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":7,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L7"}],"parameters":[{"id":1669,"name":"count","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#down"},{"id":1670,"name":"forward","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L10"}],"signatures":[{"id":1671,"name":"forward","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of columns to move forward. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":10,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L10"}],"parameters":[{"id":1672,"name":"count","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#forward"},{"id":1681,"name":"to","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L37"}],"signatures":[{"id":1682,"name":"to","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set the relative position of the cursor."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":37,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L37"}],"parameters":[{"id":1683,"name":"x","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1684,"name":"y","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#to"},{"id":1685,"name":"toAbsolute","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":40,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L40"}],"signatures":[{"id":1686,"name":"toAbsolute","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Set the absolute position of the cursor, starting from the top left."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":40,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L40"}],"parameters":[{"id":1687,"name":"x","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1688,"name":"y","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#toAbsolute"},{"id":1689,"name":"up","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":43,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L43"}],"signatures":[{"id":1690,"name":"up","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Number of rows to move up. Defaults to "},{"kind":"code","text":"`1`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":43,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L43"}],"parameters":[{"id":1691,"name":"count","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/cursor#up"}],"groups":[{"title":"Variables","children":[1673,1674,1675,1676,1677,1678,1679,1680]},{"title":"Functions","children":[1664,1667,1670,1681,1685,1689]}],"sources":[{"fileName":"packages/terminal/src/cursor.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/cursor.ts#L1"}],"permalink":"/api/terminal/namespace/cursor","previousId":1742,"nextId":1692},{"id":1692,"name":"screen","variant":"declaration","kind":4,"flags":{},"children":[{"id":1693,"name":"clear","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Clear the terminal screen."}]},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":5,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L5"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.clearScreen","permalink":"/api/terminal/namespace/screen#clear"},{"id":1694,"name":"clearTerminal","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":8,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L8"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#clearTerminal"},{"id":1695,"name":"erase","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Erase the screen and move the cursor the top left position."}]},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L11"}],"type":{"type":"intrinsic","name":"string"},"defaultValue":"ansiEscapes.eraseScreen","permalink":"/api/terminal/namespace/screen#erase"},{"id":1696,"name":"eraseDown","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":14,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L14"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseDown"},{"id":1697,"name":"eraseEndLine","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":17,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L17"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseEndLine"},{"id":1698,"name":"eraseLine","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":20,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L20"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseLine"},{"id":1702,"name":"eraseStartLine","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":26,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L26"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseStartLine"},{"id":1703,"name":"eraseUp","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":29,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L29"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#eraseUp"},{"id":1704,"name":"scrollDown","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":32,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L32"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#scrollDown"},{"id":1705,"name":"scrollUp","variant":"declaration","kind":32,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":35,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L35"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/terminal/namespace/screen#scrollUp"},{"id":1699,"name":"eraseLines","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":23,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L23"}],"signatures":[{"id":1700,"name":"eraseLines","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Erase from the current cursor position up the specified amount of rows."}]},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":23,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L23"}],"parameters":[{"id":1701,"name":"count","variant":"param","kind":32768,"flags":{},"comment":{"summary":[{"kind":"text","text":"Count of rows to erase."}]},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/namespace/screen#eraseLines"},{"id":1706,"name":"size","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":38,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L38"}],"signatures":[{"id":1707,"name":"size","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Reliably and accurately get the screen size (in "},{"kind":"code","text":"`columns`"},{"kind":"text","text":" and "},{"kind":"code","text":"`rows`"},{"kind":"text","text":")."}]},"sources":[{"fileName":"packages/terminal/src/screen.ts","line":38,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L38"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/term-size/index.d.ts","qualifiedName":"TerminalSize"},"name":"TerminalSize","package":"term-size"}}],"permalink":"/api/terminal/namespace/screen#size"}],"groups":[{"title":"Variables","children":[1693,1694,1695,1696,1697,1698,1702,1703,1704,1705]},{"title":"Functions","children":[1699,1706]}],"sources":[{"fileName":"packages/terminal/src/screen.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/screen.ts#L1"}],"permalink":"/api/terminal/namespace/screen","previousId":1663,"nextId":1741},{"id":1742,"name":"WrapOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1743,"name":"hard","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/terminal/src/text.ts","line":123,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L123"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1744,"name":"trim","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/terminal/src/text.ts","line":124,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L124"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1745,"name":"wordWrap","variant":"declaration","kind":1024,"flags":{"isOptional":true},"sources":[{"fileName":"packages/terminal/src/text.ts","line":125,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L125"}],"type":{"type":"intrinsic","name":"boolean"}}],"groups":[{"title":"Properties","children":[1743,1744,1745]}],"sources":[{"fileName":"packages/terminal/src/text.ts","line":122,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L122"}],"permalink":"/api/terminal/interface/WrapOptions","previousId":1735,"nextId":1663},{"id":1741,"name":"TruncateOptions","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":105,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L105"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/cli-truncate/index.d.ts","qualifiedName":"Options"},"name":"CliTruncateOptions","package":"cli-truncate","qualifiedName":"Options"},"permalink":"/api/terminal#TruncateOptions","previousId":1692,"nextId":1740},{"id":1740,"name":"ANSI_REGEX","variant":"declaration","kind":32,"flags":{"isConst":true},"comment":{"summary":[{"kind":"text","text":"Regular expression for matching ANSI escape codes."}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":11,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L11"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"RegExp"},"name":"RegExp","package":"typescript"},"defaultValue":"...","permalink":"/api/terminal#ANSI_REGEX","previousId":1741},{"id":1708,"name":"annotate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L23"}],"signatures":[{"id":1709,"name":"annotate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to wrap a piece of text with a visual annotation _(iTerm only)_. If a terminal doe\\nnot support annotations, it will pass the text through.\\n\\n"},{"kind":"code","text":"```ts\\nimport { annotate } from \'@boost/terminal\';\\n\\nconst text = annotate(\'fileName.js\', absFilePath);\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":23,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L23"}],"parameters":[{"id":1710,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1711,"name":"annotation","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/annotate","nextId":1712},{"id":1712,"name":"calculateWidth","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":41,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L41"}],"signatures":[{"id":1713,"name":"calculateWidth","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Calculate and return the visual width of a string (number of terminal columns required).\\nBased on [string-width](https://www.npmjs.com/package/string-width).\\n\\n"},{"kind":"code","text":"```ts\\nimport { calculateWidth } from \'@boost/terminal\';\\n\\ncalculateWidth(\'\u53e4\'); // 2\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":41,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L41"}],"parameters":[{"id":1714,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"number"}}],"permalink":"/api/terminal/function/calculateWidth","previousId":1708,"nextId":1715},{"id":1715,"name":"hasAnsi","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":55,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L55"}],"signatures":[{"id":1716,"name":"hasAnsi","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Returns true if the string contains ANSI escape codes.\\nBased on [ansi-regex](https://www.npmjs.com/package/ansi-regex).\\n\\n"},{"kind":"code","text":"```ts\\nimport { hasAnsi } from \'@boost/terminal\';\\n\\nhasAnsi(\'\\\\u001B[4mTest\\\\u001B[0m\'); // true\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":55,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L55"}],"parameters":[{"id":1717,"name":"value","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"boolean"}}],"permalink":"/api/terminal/function/hasAnsi","previousId":1712,"nextId":1718},{"id":1718,"name":"link","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":69,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L69"}],"signatures":[{"id":1719,"name":"link","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Can be used to wrap a piece of text in an ANSI escape code hyperlink.\\nIf a terminal does not support hyperlinks, it will pass the text through.\\n\\n"},{"kind":"code","text":"```ts\\nimport { link } from \'@boost/terminal\';\\n\\nconst text = link(\'Read the manual\', \'https://boostlib.dev\');\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":69,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L69"}],"parameters":[{"id":1720,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1721,"name":"url","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/link","previousId":1715,"nextId":1722},{"id":1722,"name":"sliceAnsi","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":87,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L87"}],"signatures":[{"id":1723,"name":"sliceAnsi","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Slice a string while preserving ANSI escape codes.\\nBased on [slice-ansi](https://www.npmjs.com/package/slice-ansi).\\n\\n"},{"kind":"code","text":"```ts\\nimport { sliceAnsi } from \'@boost/terminal\';\\n\\nconst text = sliceAnsi(aStringThatMayContainAnsi, 15, 25);\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":87,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L87"}],"parameters":[{"id":1724,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1725,"name":"start","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1726,"name":"end","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"intrinsic","name":"number"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/sliceAnsi","previousId":1718,"nextId":1727},{"id":1727,"name":"stripAnsi","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":101,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L101"}],"signatures":[{"id":1728,"name":"stripAnsi","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Strip all ANSI escape codes from the provided string.\\nBased on [strip-ansi](https://www.npmjs.com/package/strip-ansi).\\n\\n"},{"kind":"code","text":"```ts\\nimport { stripAnsi } from \'@boost/terminal\';\\n\\nconst text = stripAnsi(aStringThatContainsAnsi);\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":101,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L101"}],"parameters":[{"id":1729,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/stripAnsi","previousId":1722,"nextId":1730},{"id":1730,"name":"truncate","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":118,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L118"}],"signatures":[{"id":1731,"name":"truncate","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Truncate a string to a desired terminal width while preserving ANSI escape codes,\\nUnicode surrogate pairs, and fullwidth characters.\\nBased on [cli-truncate](https://www.npmjs.com/package/cli-truncate).\\n\\n"},{"kind":"code","text":"```ts\\nimport { truncate } from \'@boost/terminal\';\\n\\nconst text = truncate(aStringThatMayContainAnsi, 10, { position: \'middle\' });\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":118,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L118"}],"parameters":[{"id":1732,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1733,"name":"width","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1734,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":{"sourceFileName":"../node_modules/cli-truncate/index.d.ts","qualifiedName":"Options"},"name":"Options","package":"cli-truncate"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/truncate","previousId":1727,"nextId":1735},{"id":1735,"name":"wrapAnsi","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/terminal/src/text.ts","line":138,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L138"}],"signatures":[{"id":1736,"name":"wrapAnsi","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Wrap a string that contains ANSI escape codes to a desired terminal width.\\nBased on [wrap-ansi](https://www.npmjs.com/package/wrap-ansi).\\n\\n"},{"kind":"code","text":"```ts\\nimport { wrapAnsi } from \'@boost/terminal\';\\n\\nconst text = wrapAnsi(aStringThatContainsAnsi, 20);\\n```"}]},"sources":[{"fileName":"packages/terminal/src/text.ts","line":138,"character":16,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/text.ts#L138"}],"parameters":[{"id":1737,"name":"text","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}},{"id":1738,"name":"width","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"number"}},{"id":1739,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1742,"name":"WrapOptions","package":"@boost/terminal"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/terminal/function/wrapAnsi","previousId":1730,"nextId":1742}],"groups":[{"title":"Functions","children":[1708,1712,1715,1718,1722,1727,1730,1735]},{"title":"Interfaces","children":[1742]},{"title":"Namespaces","children":[1663,1692]},{"title":"Type Aliases","children":[1741]},{"title":"Variables","children":[1740]}],"sources":[{"fileName":"packages/terminal/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/terminal/src/index.ts#L1"}],"permalink":"/api/terminal"},"urlSlug":"terminal"}],"packageName":"@boost/terminal","packageVersion":"5.0.0-alpha.2"},{"entryPoints":[{"index":true,"label":"Index","reflection":{"id":8,"name":"@boost/translate","variant":"declaration","kind":2,"flags":{},"children":[{"id":1768,"name":"MessageOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1771,"name":"context","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Context used for special parsing (male, female, etc)."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L17"}],"type":{"type":"intrinsic","name":"string"}},{"id":1770,"name":"count","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Count used to determine plurals."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L15"}],"type":{"type":"intrinsic","name":"number"}},{"id":1769,"name":"defaultValue","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Default value to return if a translation was not found."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L13"}],"type":{"type":"intrinsic","name":"string"}},{"id":1772,"name":"interpolation","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Interpolation options to pass down."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L19"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/i18next/typescript/options.d.ts","qualifiedName":"InterpolationOptions"},"name":"InterpolationOptions","package":"i18next"}},{"id":1773,"name":"locale","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Force translation to this locale."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L21"}],"type":{"type":"intrinsic","name":"string"}},{"id":1774,"name":"postProcess","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Post-processors to run on the translation."}]},"sources":[{"fileName":"packages/translate/src/types.ts","line":23,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L23"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}}],"groups":[{"title":"Properties","children":[1771,1770,1769,1772,1773,1774]}],"sources":[{"fileName":"packages/translate/src/types.ts","line":11,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L11"}],"permalink":"/api/translate/interface/MessageOptions","previousId":1746,"nextId":1775},{"id":1775,"name":"Translator","variant":"declaration","kind":256,"flags":{},"children":[{"id":1778,"name":"changeLocale","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":30,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L30"}],"type":{"type":"reflection","declaration":{"id":1779,"name":"__type","variant":"declaration","kind":65536,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":30,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L30"}],"signatures":[{"id":1780,"name":"__type","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":30,"character":15,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L30"}],"parameters":[{"id":1781,"name":"locale","variant":"param","kind":32768,"flags":{},"type":{"type":"intrinsic","name":"string"}}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"intrinsic","name":"void"}],"name":"Promise","package":"typescript"}}]}}},{"id":1776,"name":"direction","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":28,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L28"}],"type":{"type":"reference","target":1764,"name":"Direction","package":"@boost/translate"}},{"id":1777,"name":"locale","variant":"declaration","kind":1024,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":29,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L29"}],"type":{"type":"intrinsic","name":"string"}}],"groups":[{"title":"Properties","children":[1778,1776,1777]}],"sources":[{"fileName":"packages/translate/src/types.ts","line":26,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L26"}],"signatures":[{"id":1783,"name":"Translator","variant":"signature","kind":4096,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":27,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L27"}],"parameters":[{"id":1784,"name":"key","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":1785,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1767,"name":"InterpolationParams","package":"@boost/translate"}},{"id":1786,"name":"options","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"reference","target":1768,"name":"MessageOptions","package":"@boost/translate"}}],"type":{"type":"intrinsic","name":"string"}}],"permalink":"/api/translate/interface/Translator","previousId":1768,"nextId":1751},{"id":1751,"name":"TranslatorOptions","variant":"declaration","kind":256,"flags":{},"children":[{"id":1752,"name":"autoDetect","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Automatically detect the locale from the environment. Defaults to "},{"kind":"code","text":"`true`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":11,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L11"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1753,"name":"debug","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Enable debugging by logging info to the console."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":13,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L13"}],"type":{"type":"intrinsic","name":"boolean"}},{"id":1754,"name":"fallbackLocale","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Fallback locale(s) to use when the detected locale isn\'t translated. Defaults to "},{"kind":"code","text":"`en`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":15,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L15"}],"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":1755,"name":"locale","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Locale to explicitly use."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":17,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L17"}],"type":{"type":"intrinsic","name":"string"}},{"id":1756,"name":"lookupType","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"Order in which to load and lookup locale translations."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":19,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L19"}],"type":{"type":"union","types":[{"type":"literal","value":"all"},{"type":"literal","value":"currentOnly"},{"type":"literal","value":"languageOnly"}]}},{"id":1757,"name":"resourceFormat","variant":"declaration","kind":1024,"flags":{"isOptional":true},"comment":{"summary":[{"kind":"text","text":"File format resource bundles are written in. Defaults to "},{"kind":"code","text":"`yaml`"},{"kind":"text","text":"."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":21,"character":1,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L21"}],"type":{"type":"reference","target":1765,"name":"Format","package":"@boost/translate"}}],"groups":[{"title":"Properties","children":[1752,1753,1754,1755,1756,1757]}],"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":9,"character":17,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L9"}],"permalink":"/api/translate/interface/TranslatorOptions","previousId":1775,"nextId":1764},{"id":1764,"name":"Direction","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":3,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L3"}],"type":{"type":"union","types":[{"type":"literal","value":"ltr"},{"type":"literal","value":"rtl"}]},"permalink":"/api/translate#Direction","previousId":1751,"nextId":1765},{"id":1765,"name":"Format","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":5,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L5"}],"type":{"type":"union","types":[{"type":"literal","value":"cjs"},{"type":"literal","value":"js"},{"type":"literal","value":"json"},{"type":"literal","value":"mjs"},{"type":"literal","value":"yaml"}]},"permalink":"/api/translate#Format","previousId":1764,"nextId":1767},{"id":1767,"name":"InterpolationParams","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":9,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L9"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Record"},"typeArguments":[{"type":"intrinsic","name":"string"},{"type":"intrinsic","name":"unknown"}],"name":"Record","package":"typescript"},"permalink":"/api/translate#InterpolationParams","previousId":1765,"nextId":1766},{"id":1766,"name":"Locale","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/types.ts","line":7,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/types.ts#L7"}],"type":{"type":"intrinsic","name":"string"},"permalink":"/api/translate#Locale","previousId":1767,"nextId":1758},{"id":1758,"name":"TranslateErrorCode","variant":"declaration","kind":2097152,"flags":{},"sources":[{"fileName":"packages/translate/src/TranslateError.ts","line":10,"character":12,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/TranslateError.ts#L10"}],"type":{"type":"typeOperator","operator":"keyof","target":{"type":"query","queryType":{"type":"reference","target":{"sourceFileName":"../packages/translate/src/TranslateError.ts","qualifiedName":"errors"},"name":"errors","package":"@boost/translate","preferValues":true}}},"permalink":"/api/translate#TranslateErrorCode","previousId":1766,"nextId":1759},{"id":1759,"name":"TranslateError","variant":"declaration","kind":32,"flags":{"isConst":true},"sources":[{"fileName":"packages/translate/src/TranslateError.ts","line":12,"character":13,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/TranslateError.ts#L12"}],"type":{"type":"reflection","declaration":{"id":1760,"name":"__type","variant":"declaration","kind":512,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"signatures":[{"id":1761,"name":"new TranslateError","variant":"signature","kind":16384,"flags":{},"sources":[{"fileName":"packages/internal/mjs/createScopedError.d.ts","line":6,"character":118}],"parameters":[{"id":1762,"name":"code","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"literal","value":"LOCALE_REQUIRED"},{"type":"literal","value":"NAMESPACE_REQUIRED"},{"type":"literal","value":"RESOURCE_PATH_INVALID"},{"type":"literal","value":"RESOURCES_REQUIRED"}]}},{"id":1763,"name":"params","variant":"param","kind":32768,"flags":{"isOptional":true},"type":{"type":"array","elementType":{"type":"intrinsic","name":"unknown"}}}],"type":{"type":"intersection","types":[{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Error"},"name":"Error","package":"typescript"},{"type":"reference","target":{"sourceFileName":"../packages/internal/src/createScopedError.ts","qualifiedName":"ScopedError"},"typeArguments":[{"type":"union","types":[{"type":"literal","value":"LOCALE_REQUIRED"},{"type":"literal","value":"NAMESPACE_REQUIRED"},{"type":"literal","value":"RESOURCE_PATH_INVALID"},{"type":"literal","value":"RESOURCES_REQUIRED"}]}],"name":"ScopedError","package":"@boost/internal"}]}}]}},"defaultValue":"...","permalink":"/api/translate#TranslateError","previousId":1758},{"id":1746,"name":"createTranslator","variant":"declaration","kind":64,"flags":{},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":28,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L28"}],"signatures":[{"id":1747,"name":"createTranslator","variant":"signature","kind":4096,"flags":{},"comment":{"summary":[{"kind":"text","text":"Create and return a "},{"kind":"code","text":"`Translator`"},{"kind":"text","text":" instance with the defined namespace.\\nA list of resource paths are required for locating translation files."}]},"sources":[{"fileName":"packages/translate/src/createTranslator.ts","line":28,"character":22,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/createTranslator.ts#L28"}],"parameters":[{"id":1748,"name":"namespace","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"intrinsic","name":"string"},{"type":"array","elementType":{"type":"intrinsic","name":"string"}}]}},{"id":1749,"name":"resourcePath","variant":"param","kind":32768,"flags":{},"type":{"type":"union","types":[{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"},{"type":"array","elementType":{"type":"reference","target":{"sourceFileName":"../packages/common/src/types.ts","qualifiedName":"PortablePath"},"name":"PortablePath","package":"@boost/common"}}]}},{"id":1750,"name":"options","variant":"param","kind":32768,"flags":{},"type":{"type":"reference","target":1751,"name":"TranslatorOptions","package":"@boost/translate"},"defaultValue":"{}"}],"type":{"type":"reference","target":{"sourceFileName":"../node_modules/typescript/lib/lib.es5.d.ts","qualifiedName":"Promise"},"typeArguments":[{"type":"reference","target":1775,"name":"Translator","package":"@boost/translate"}],"name":"Promise","package":"typescript"}}],"permalink":"/api/translate/function/createTranslator","nextId":1768}],"groups":[{"title":"Functions","children":[1746]},{"title":"Interfaces","children":[1768,1775,1751]},{"title":"Type Aliases","children":[1764,1765,1767,1766,1758]},{"title":"Variables","children":[1759]}],"sources":[{"fileName":"packages/translate/src/index.ts","line":1,"character":0,"url":"https://github.com/milesj/boost/blob/master/packages/translate/src/index.ts#L1"}],"permalink":"/api/translate"},"urlSlug":"translate"}],"packageName":"@boost/translate","packageVersion":"5.0.0-alpha.2"}]')}}]); \ No newline at end of file diff --git a/assets/js/runtime~main.a2f5ff5c.js b/assets/js/runtime~main.2fd1d389.js similarity index 94% rename from assets/js/runtime~main.a2f5ff5c.js rename to assets/js/runtime~main.2fd1d389.js index bc89b1091..d90da513a 100644 --- a/assets/js/runtime~main.a2f5ff5c.js +++ b/assets/js/runtime~main.2fd1d389.js @@ -1 +1 @@ -(()=>{"use strict";var e,a,f,t,c,r={},d={};function b(e){var a=d[e];if(void 0!==a)return a.exports;var f=d[e]={id:e,loaded:!1,exports:{}};return r[e].call(f.exports,f,f.exports,b),f.loaded=!0,f.exports}b.m=r,b.c=d,e=[],b.O=(a,f,t,c)=>{if(!f){var r=1/0;for(i=0;i=c)&&Object.keys(b.O).every((e=>b.O[e](f[o])))?f.splice(o--,1):(d=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[f,t,c]},b.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return b.d(a,{a:a}),a},f=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,b.t=function(e,t){if(1&t&&(e=this(e)),8&t)return e;if("object"==typeof e&&e){if(4&t&&e.__esModule)return e;if(16&t&&"function"==typeof e.then)return e}var c=Object.create(null);b.r(c);var r={};a=a||[null,f({}),f([]),f(f)];for(var d=2&t&&e;"object"==typeof d&&!~a.indexOf(d);d=f(d))Object.getOwnPropertyNames(d).forEach((a=>r[a]=()=>e[a]));return r.default=()=>e,b.d(c,r),c},b.d=(e,a)=>{for(var f in a)b.o(a,f)&&!b.o(e,f)&&Object.defineProperty(e,f,{enumerable:!0,get:a[f]})},b.f={},b.e=e=>Promise.all(Object.keys(b.f).reduce(((a,f)=>(b.f[f](e,a),a)),[])),b.u=e=>"assets/js/"+({216:"5916f338",268:"08eb9bb9",348:"0fd7368e",568:"d70329c2",752:"2e1e3c4f",772:"68e3f9c8",804:"ceaa5638",936:"1b1ac4d2",945:"cf6c81f3",1576:"fe40ce61",2197:"ba61d949",3392:"d3b58958",3852:"dde610f4",4264:"b3bdca69",4304:"5e95c892",4360:"7730a0c0",4584:"e366df02",4666:"a94703ab",4692:"f64f7040",4960:"c273a4cf",5032:"4b84920d",5096:"2087399e",5104:"59d0cecd",5232:"d3e404c3",5274:"4bb56a16",5296:"7445e833",5408:"17331c4c",5608:"5fe98661",5696:"935f2afb",6304:"331b3553",6500:"a7bd4aaa",6648:"fd2fef28",6688:"01b18476",6696:"a52abfe1",6752:"17896441",6840:"77069ab5",7240:"b17174d3",7904:"82a02f0c",8133:"1c67fcc5",8552:"1df93b7f",8708:"c9be295d",8744:"026e8a07",9368:"42406d60",9508:"0da5837a",9556:"f4f26ebe",9644:"1adde784",9648:"1a4e3797",9692:"ec0ace2a",9928:"65b10c26",9956:"4edc808e",9984:"efaeab25"}[e]||e)+"."+{216:"fd01fd38",268:"f5031473",348:"1af64ef0",568:"dccd7c2f",752:"945f0242",772:"769cdf37",804:"9ce2a810",936:"8ac64cd4",945:"6719a2d6",1576:"83aa5087",1936:"777b399c",2197:"a95ed2d7",2952:"8186edcb",3392:"44fdd3db",3852:"3c20348f",4148:"861f6ba2",4264:"ad7e330b",4304:"b8c90300",4352:"7665968c",4360:"60614daf",4584:"d984a1a4",4666:"e146db47",4692:"11439a94",4960:"3f227de0",5032:"e2ecda82",5096:"cae9cc8e",5104:"c5ea4156",5232:"d29a0901",5274:"96218375",5296:"481239b4",5408:"22ac215a",5608:"d0ceeab0",5696:"aa7e124d",6304:"01e5e6ce",6500:"e67d9b56",6642:"59416d39",6648:"98b2bc92",6688:"02f5f071",6696:"f7f7141d",6752:"4599e670",6840:"c9306800",7240:"4da0163d",7292:"e0916bee",7813:"967c6584",7904:"971ad6b9",8133:"15c49c9b",8552:"10bd358c",8708:"eb6ce5f2",8744:"13de9817",9368:"679b1294",9508:"55455915",9556:"2a97e40e",9644:"8f15b036",9648:"779c93b3",9692:"82c83eb3",9928:"f42ceca0",9956:"bfb350db",9984:"05177254"}[e]+".js",b.miniCssF=e=>{},b.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),b.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),t={},c="website:",b.l=(e,a,f,r)=>{if(t[e])t[e].push(a);else{var d,o;if(void 0!==f)for(var n=document.getElementsByTagName("script"),i=0;i{d.onerror=d.onload=null,clearTimeout(s);var c=t[e];if(delete t[e],d.parentNode&&d.parentNode.removeChild(d),c&&c.forEach((e=>e(f))),a)return a(f)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),o&&document.head.appendChild(d)}},b.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},b.p="/",b.gca=function(e){return e={17896441:"6752","5916f338":"216","08eb9bb9":"268","0fd7368e":"348",d70329c2:"568","2e1e3c4f":"752","68e3f9c8":"772",ceaa5638:"804","1b1ac4d2":"936",cf6c81f3:"945",fe40ce61:"1576",ba61d949:"2197",d3b58958:"3392",dde610f4:"3852",b3bdca69:"4264","5e95c892":"4304","7730a0c0":"4360",e366df02:"4584",a94703ab:"4666",f64f7040:"4692",c273a4cf:"4960","4b84920d":"5032","2087399e":"5096","59d0cecd":"5104",d3e404c3:"5232","4bb56a16":"5274","7445e833":"5296","17331c4c":"5408","5fe98661":"5608","935f2afb":"5696","331b3553":"6304",a7bd4aaa:"6500",fd2fef28:"6648","01b18476":"6688",a52abfe1:"6696","77069ab5":"6840",b17174d3:"7240","82a02f0c":"7904","1c67fcc5":"8133","1df93b7f":"8552",c9be295d:"8708","026e8a07":"8744","42406d60":"9368","0da5837a":"9508",f4f26ebe:"9556","1adde784":"9644","1a4e3797":"9648",ec0ace2a:"9692","65b10c26":"9928","4edc808e":"9956",efaeab25:"9984"}[e]||e,b.p+b.u(e)},(()=>{var e={296:0,2176:0};b.f.j=(a,f)=>{var t=b.o(e,a)?e[a]:void 0;if(0!==t)if(t)f.push(t[2]);else if(/^2(17|9)6$/.test(a))e[a]=0;else{var c=new Promise(((f,c)=>t=e[a]=[f,c]));f.push(t[2]=c);var r=b.p+b.u(a),d=new Error;b.l(r,(f=>{if(b.o(e,a)&&(0!==(t=e[a])&&(e[a]=void 0),t)){var c=f&&("load"===f.type?"missing":f.type),r=f&&f.target&&f.target.src;d.message="Loading chunk "+a+" failed.\n("+c+": "+r+")",d.name="ChunkLoadError",d.type=c,d.request=r,t[1](d)}}),"chunk-"+a,a)}},b.O.j=a=>0===e[a];var a=(a,f)=>{var t,c,r=f[0],d=f[1],o=f[2],n=0;if(r.some((a=>0!==e[a]))){for(t in d)b.o(d,t)&&(b.m[t]=d[t]);if(o)var i=o(b)}for(a&&a(f);n{"use strict";var e,a,f,t,c,r={},d={};function b(e){var a=d[e];if(void 0!==a)return a.exports;var f=d[e]={id:e,loaded:!1,exports:{}};return r[e].call(f.exports,f,f.exports,b),f.loaded=!0,f.exports}b.m=r,b.c=d,e=[],b.O=(a,f,t,c)=>{if(!f){var r=1/0;for(i=0;i=c)&&Object.keys(b.O).every((e=>b.O[e](f[o])))?f.splice(o--,1):(d=!1,c0&&e[i-1][2]>c;i--)e[i]=e[i-1];e[i]=[f,t,c]},b.n=e=>{var a=e&&e.__esModule?()=>e.default:()=>e;return b.d(a,{a:a}),a},f=Object.getPrototypeOf?e=>Object.getPrototypeOf(e):e=>e.__proto__,b.t=function(e,t){if(1&t&&(e=this(e)),8&t)return e;if("object"==typeof e&&e){if(4&t&&e.__esModule)return e;if(16&t&&"function"==typeof e.then)return e}var c=Object.create(null);b.r(c);var r={};a=a||[null,f({}),f([]),f(f)];for(var d=2&t&&e;"object"==typeof d&&!~a.indexOf(d);d=f(d))Object.getOwnPropertyNames(d).forEach((a=>r[a]=()=>e[a]));return r.default=()=>e,b.d(c,r),c},b.d=(e,a)=>{for(var f in a)b.o(a,f)&&!b.o(e,f)&&Object.defineProperty(e,f,{enumerable:!0,get:a[f]})},b.f={},b.e=e=>Promise.all(Object.keys(b.f).reduce(((a,f)=>(b.f[f](e,a),a)),[])),b.u=e=>"assets/js/"+({216:"5916f338",268:"08eb9bb9",348:"0fd7368e",568:"d70329c2",752:"2e1e3c4f",772:"68e3f9c8",804:"ceaa5638",936:"1b1ac4d2",945:"cf6c81f3",1576:"fe40ce61",2197:"ba61d949",3392:"d3b58958",3852:"dde610f4",4264:"b3bdca69",4304:"5e95c892",4360:"7730a0c0",4584:"e366df02",4666:"a94703ab",4692:"f64f7040",4960:"c273a4cf",5032:"4b84920d",5096:"2087399e",5104:"59d0cecd",5232:"d3e404c3",5274:"4bb56a16",5296:"7445e833",5408:"17331c4c",5608:"5fe98661",5696:"935f2afb",6304:"331b3553",6500:"a7bd4aaa",6648:"fd2fef28",6688:"01b18476",6696:"a52abfe1",6752:"17896441",6840:"77069ab5",7240:"b17174d3",7904:"82a02f0c",8133:"1c67fcc5",8552:"1df93b7f",8708:"c9be295d",8744:"026e8a07",9368:"42406d60",9508:"0da5837a",9556:"f4f26ebe",9644:"1adde784",9648:"1a4e3797",9692:"ec0ace2a",9928:"65b10c26",9956:"4edc808e",9984:"efaeab25"}[e]||e)+"."+{216:"fd01fd38",268:"f5031473",348:"1af64ef0",568:"dccd7c2f",752:"945f0242",772:"769cdf37",804:"9ce2a810",936:"8ac64cd4",945:"6719a2d6",1576:"83aa5087",1936:"777b399c",2197:"a95ed2d7",2952:"8186edcb",3392:"44fdd3db",3852:"3c20348f",4148:"861f6ba2",4264:"ad7e330b",4304:"b8c90300",4352:"7665968c",4360:"60614daf",4584:"d984a1a4",4666:"e146db47",4692:"11439a94",4960:"3f227de0",5032:"e2ecda82",5096:"224ef299",5104:"c5ea4156",5232:"d29a0901",5274:"96218375",5296:"481239b4",5408:"22ac215a",5608:"d0ceeab0",5696:"4c24619f",6304:"01e5e6ce",6500:"e67d9b56",6642:"59416d39",6648:"98b2bc92",6688:"02f5f071",6696:"f7f7141d",6752:"4599e670",6840:"c9306800",7240:"4da0163d",7292:"e0916bee",7813:"967c6584",7904:"971ad6b9",8133:"15c49c9b",8552:"10bd358c",8708:"caaa6d86",8744:"13de9817",9368:"679b1294",9508:"55455915",9556:"2a97e40e",9644:"8f15b036",9648:"779c93b3",9692:"82c83eb3",9928:"f42ceca0",9956:"292196cf",9984:"05177254"}[e]+".js",b.miniCssF=e=>{},b.g=function(){if("object"==typeof globalThis)return globalThis;try{return this||new Function("return this")()}catch(e){if("object"==typeof window)return window}}(),b.o=(e,a)=>Object.prototype.hasOwnProperty.call(e,a),t={},c="website:",b.l=(e,a,f,r)=>{if(t[e])t[e].push(a);else{var d,o;if(void 0!==f)for(var n=document.getElementsByTagName("script"),i=0;i{d.onerror=d.onload=null,clearTimeout(s);var c=t[e];if(delete t[e],d.parentNode&&d.parentNode.removeChild(d),c&&c.forEach((e=>e(f))),a)return a(f)},s=setTimeout(l.bind(null,void 0,{type:"timeout",target:d}),12e4);d.onerror=l.bind(null,d.onerror),d.onload=l.bind(null,d.onload),o&&document.head.appendChild(d)}},b.r=e=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(e,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(e,"__esModule",{value:!0})},b.p="/",b.gca=function(e){return e={17896441:"6752","5916f338":"216","08eb9bb9":"268","0fd7368e":"348",d70329c2:"568","2e1e3c4f":"752","68e3f9c8":"772",ceaa5638:"804","1b1ac4d2":"936",cf6c81f3:"945",fe40ce61:"1576",ba61d949:"2197",d3b58958:"3392",dde610f4:"3852",b3bdca69:"4264","5e95c892":"4304","7730a0c0":"4360",e366df02:"4584",a94703ab:"4666",f64f7040:"4692",c273a4cf:"4960","4b84920d":"5032","2087399e":"5096","59d0cecd":"5104",d3e404c3:"5232","4bb56a16":"5274","7445e833":"5296","17331c4c":"5408","5fe98661":"5608","935f2afb":"5696","331b3553":"6304",a7bd4aaa:"6500",fd2fef28:"6648","01b18476":"6688",a52abfe1:"6696","77069ab5":"6840",b17174d3:"7240","82a02f0c":"7904","1c67fcc5":"8133","1df93b7f":"8552",c9be295d:"8708","026e8a07":"8744","42406d60":"9368","0da5837a":"9508",f4f26ebe:"9556","1adde784":"9644","1a4e3797":"9648",ec0ace2a:"9692","65b10c26":"9928","4edc808e":"9956",efaeab25:"9984"}[e]||e,b.p+b.u(e)},(()=>{var e={296:0,2176:0};b.f.j=(a,f)=>{var t=b.o(e,a)?e[a]:void 0;if(0!==t)if(t)f.push(t[2]);else if(/^2(17|9)6$/.test(a))e[a]=0;else{var c=new Promise(((f,c)=>t=e[a]=[f,c]));f.push(t[2]=c);var r=b.p+b.u(a),d=new Error;b.l(r,(f=>{if(b.o(e,a)&&(0!==(t=e[a])&&(e[a]=void 0),t)){var c=f&&("load"===f.type?"missing":f.type),r=f&&f.target&&f.target.src;d.message="Loading chunk "+a+" failed.\n("+c+": "+r+")",d.name="ChunkLoadError",d.type=c,d.request=r,t[1](d)}}),"chunk-"+a,a)}},b.O.j=a=>0===e[a];var a=(a,f)=>{var t,c,r=f[0],d=f[1],o=f[2],n=0;if(r.some((a=>0!==e[a]))){for(t in d)b.o(d,t)&&(b.m[t]=d[t]);if(o)var i=o(b)}for(a&&a(f);n Arguments | Boost - + diff --git a/docs/cli/components/index.html b/docs/cli/components/index.html index 73269ca4e..5d7598fc0 100644 --- a/docs/cli/components/index.html +++ b/docs/cli/components/index.html @@ -4,7 +4,7 @@ Components | Boost - + diff --git a/docs/cli/index.html b/docs/cli/index.html index 09e9f9a1f..2b1393a5e 100644 --- a/docs/cli/index.html +++ b/docs/cli/index.html @@ -4,7 +4,7 @@ CLIs | Boost - + diff --git a/docs/cli/prompts/index.html b/docs/cli/prompts/index.html index 85aa48462..5bff1ddd2 100644 --- a/docs/cli/prompts/index.html +++ b/docs/cli/prompts/index.html @@ -4,7 +4,7 @@ Prompts | Boost - + diff --git a/docs/common/index.html b/docs/common/index.html index 2de0f2aa5..67158880c 100644 --- a/docs/common/index.html +++ b/docs/common/index.html @@ -4,7 +4,7 @@ Common utilities | Boost - + diff --git a/docs/config/index.html b/docs/config/index.html index ab613f285..958057f9c 100644 --- a/docs/config/index.html +++ b/docs/config/index.html @@ -4,7 +4,7 @@ Configuration | Boost - + diff --git a/docs/crash/index.html b/docs/crash/index.html index c5e53a5f0..602fddd80 100644 --- a/docs/crash/index.html +++ b/docs/crash/index.html @@ -4,7 +4,7 @@ Crash reporting | Boost - + diff --git a/docs/debug/index.html b/docs/debug/index.html index 8fb0af54f..c3aa7cf08 100644 --- a/docs/debug/index.html +++ b/docs/debug/index.html @@ -4,7 +4,7 @@ Debugging | Boost - + diff --git a/docs/decorators/index.html b/docs/decorators/index.html index e019630ad..1e68356f9 100644 --- a/docs/decorators/index.html +++ b/docs/decorators/index.html @@ -4,7 +4,7 @@ Decorators | Boost - + diff --git a/docs/event/index.html b/docs/event/index.html index e0b3f8356..246211918 100644 --- a/docs/event/index.html +++ b/docs/event/index.html @@ -4,7 +4,7 @@ Events | Boost - + diff --git a/docs/index.html b/docs/index.html index 7a7bd8813..e1e98dd47 100644 --- a/docs/index.html +++ b/docs/index.html @@ -3,13 +3,13 @@ -Introduction | Boost - +Introduction | Boost + -

Introduction

A collection of type-safe cross-platform packages for building robust server-side and client-side -applications, packages, and tooling.

+

Introduction

A collection of type-safe cross-platform ESM packages for building robust server-side and +client-side applications, packages, and tooling.

Packages​

  • args - Command line argument parsing and formatting.
    • @@ -29,8 +29,9 @@

    PackagesRequirements​

    • Linux, OSX, Windows
      • -
    • Node.js v16.20+ (for backend and tooling)
      • +
    • Node.js v18.12+ (for backend and tooling)
    • Edge, Chrome, Firefox (for frontend)
      • +
    • ESM only

    Environments​

    Each Boost package is usable in one or many of the following environments. Each supported diff --git a/docs/internal/errors/index.html b/docs/internal/errors/index.html index 8f39c1982..be0494667 100644 --- a/docs/internal/errors/index.html +++ b/docs/internal/errors/index.html @@ -4,7 +4,7 @@ Errors | Boost - + diff --git a/docs/log/index.html b/docs/log/index.html index e66f6de3f..c9ed7e4db 100644 --- a/docs/log/index.html +++ b/docs/log/index.html @@ -4,7 +4,7 @@ Logging | Boost - + diff --git a/docs/migrate/3.0/index.html b/docs/migrate/3.0/index.html index 73bad5584..397ea6eb9 100644 --- a/docs/migrate/3.0/index.html +++ b/docs/migrate/3.0/index.html @@ -4,7 +4,7 @@ 3.0 migration | Boost - + diff --git a/docs/migrate/4.0/index.html b/docs/migrate/4.0/index.html index 60c26cef1..ccedf848f 100644 --- a/docs/migrate/4.0/index.html +++ b/docs/migrate/4.0/index.html @@ -4,7 +4,7 @@ 4.0 migration | Boost - + diff --git a/docs/migrate/5.0/index.html b/docs/migrate/5.0/index.html index cb2822001..52382a56c 100644 --- a/docs/migrate/5.0/index.html +++ b/docs/migrate/5.0/index.html @@ -4,7 +4,7 @@ 5.0 migration | Boost - + @@ -13,7 +13,7 @@

    All packages​

    • Requires TypeScript v5 or greater.
      • -
    • Dropped Node.js v14 support. Now requires v16.20 and above.
      • +
    • Dropped Node.js v16 support. Now requires v18.12 and above.
    • Updated many dependencies to their latest major version.
    • Migrated all test utilities from Jest to Vitest.
    diff --git a/docs/module/index.html b/docs/module/index.html index c6b92b1d0..d42e1e19d 100644 --- a/docs/module/index.html +++ b/docs/module/index.html @@ -4,7 +4,7 @@ Modules | Boost - + diff --git a/docs/pipeline/index.html b/docs/pipeline/index.html index 5de8c712f..57198dc28 100644 --- a/docs/pipeline/index.html +++ b/docs/pipeline/index.html @@ -4,7 +4,7 @@ Pipelines | Boost - + diff --git a/docs/plugin/index.html b/docs/plugin/index.html index 86c9fc01b..d8bb3fda5 100644 --- a/docs/plugin/index.html +++ b/docs/plugin/index.html @@ -4,7 +4,7 @@ Plugins | Boost - + diff --git a/docs/terminal/index.html b/docs/terminal/index.html index 28ad0d0e9..27e647936 100644 --- a/docs/terminal/index.html +++ b/docs/terminal/index.html @@ -4,7 +4,7 @@ Terminal utilities | Boost - + diff --git a/docs/translate/index.html b/docs/translate/index.html index 49692069d..c4c9b99f4 100644 --- a/docs/translate/index.html +++ b/docs/translate/index.html @@ -4,7 +4,7 @@ Translations | Boost - + diff --git a/index.html b/index.html index c5982e923..f19f7dd24 100644 --- a/index.html +++ b/index.html @@ -4,7 +4,7 @@ Cross-platform tooling | Boost - + diff --git a/search/index.html b/search/index.html index 253cdb135..a2535720d 100644 --- a/search/index.html +++ b/search/index.html @@ -4,7 +4,7 @@ Search the documentation | Boost - +