From 390fb8ee2680e8048c0966ee2e94bbb21414c3e9 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Wed, 18 Oct 2023 14:23:53 -0500 Subject: [PATCH 01/43] proof-of-concept for multi-instance api docs --- api/@xstate/react/index.md | 5 +++++ api/xstate/index.md | 5 +++++ docusaurus.config.js | 19 +++++++++++++++++++ sidebars.js | 9 ++++++++- 4 files changed, 37 insertions(+), 1 deletion(-) create mode 100644 api/@xstate/react/index.md create mode 100644 api/xstate/index.md diff --git a/api/@xstate/react/index.md b/api/@xstate/react/index.md new file mode 100644 index 000000000..d8870a65f --- /dev/null +++ b/api/@xstate/react/index.md @@ -0,0 +1,5 @@ +--- +title: @xstate/react API +--- + +# @xstate/react API diff --git a/api/xstate/index.md b/api/xstate/index.md new file mode 100644 index 000000000..d55fbdafa --- /dev/null +++ b/api/xstate/index.md @@ -0,0 +1,5 @@ +--- +title: XState API +--- + +# XState API diff --git a/docusaurus.config.js b/docusaurus.config.js index 2d72863f6..8a8c797ef 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -133,6 +133,25 @@ const config = { }, }, ], + + [ + '@docusaurus/plugin-content-docs', + { + id: 'xstate-api', + path: 'api/xstate', + routeBasePath: 'api/xstate', + // sidebarPath: require.resolve('./sidebars.js') + }, + ], + [ + '@docusaurus/plugin-content-docs', + { + id: 'xstate-react-api', + path: 'api/@xstate/react', + routeBasePath: 'api/@xstate/react', + // sidebarPath: require.resolve('./sidebars.js') + } + ] ], themeConfig: diff --git a/sidebars.js b/sidebars.js index 2541eec1f..b81234f29 100644 --- a/sidebars.js +++ b/sidebars.js @@ -18,7 +18,7 @@ const sidebars = { // But you can create a sidebar manually - tutorialSidebar: [ + docs: [ { type: 'doc', label: 'About Stately and XState', @@ -349,6 +349,13 @@ const sidebars = { id: 'glossary', }, ], + + api: [ + { + type: 'autogenerated', + dirName: 'api' + } + ] }; module.exports = sidebars; From 2ceadb4f3b91f79777470c03a1bbc09e4092281f Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Wed, 18 Oct 2023 14:24:51 -0500 Subject: [PATCH 02/43] fix frontmatter bug --- api/@xstate/react/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/api/@xstate/react/index.md b/api/@xstate/react/index.md index d8870a65f..7a67c493e 100644 --- a/api/@xstate/react/index.md +++ b/api/@xstate/react/index.md @@ -1,5 +1,5 @@ --- -title: @xstate/react API +title: "@xstate/react API" --- # @xstate/react API From 954a275c363a9c728f9dc15a36ff55357087d878 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Wed, 18 Oct 2023 14:25:45 -0500 Subject: [PATCH 03/43] example versioned apis --- xstate-api_versioned_docs/version-5.0.0/index.md | 5 +++++ xstate-api_versioned_sidebars/version-5.0.0-sidebars.json | 8 ++++++++ xstate-api_versions.json | 3 +++ xstate-react-api_versioned_docs/version-5.0.0/index.md | 5 +++++ .../version-5.0.0-sidebars.json | 8 ++++++++ xstate-react-api_versions.json | 3 +++ 6 files changed, 32 insertions(+) create mode 100644 xstate-api_versioned_docs/version-5.0.0/index.md create mode 100644 xstate-api_versioned_sidebars/version-5.0.0-sidebars.json create mode 100644 xstate-api_versions.json create mode 100644 xstate-react-api_versioned_docs/version-5.0.0/index.md create mode 100644 xstate-react-api_versioned_sidebars/version-5.0.0-sidebars.json create mode 100644 xstate-react-api_versions.json diff --git a/xstate-api_versioned_docs/version-5.0.0/index.md b/xstate-api_versioned_docs/version-5.0.0/index.md new file mode 100644 index 000000000..d55fbdafa --- /dev/null +++ b/xstate-api_versioned_docs/version-5.0.0/index.md @@ -0,0 +1,5 @@ +--- +title: XState API +--- + +# XState API diff --git a/xstate-api_versioned_sidebars/version-5.0.0-sidebars.json b/xstate-api_versioned_sidebars/version-5.0.0-sidebars.json new file mode 100644 index 000000000..cff0c94e1 --- /dev/null +++ b/xstate-api_versioned_sidebars/version-5.0.0-sidebars.json @@ -0,0 +1,8 @@ +{ + "defaultSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/xstate-api_versions.json b/xstate-api_versions.json new file mode 100644 index 000000000..b7faebe93 --- /dev/null +++ b/xstate-api_versions.json @@ -0,0 +1,3 @@ +[ + "5.0.0" +] diff --git a/xstate-react-api_versioned_docs/version-5.0.0/index.md b/xstate-react-api_versioned_docs/version-5.0.0/index.md new file mode 100644 index 000000000..7a67c493e --- /dev/null +++ b/xstate-react-api_versioned_docs/version-5.0.0/index.md @@ -0,0 +1,5 @@ +--- +title: "@xstate/react API" +--- + +# @xstate/react API diff --git a/xstate-react-api_versioned_sidebars/version-5.0.0-sidebars.json b/xstate-react-api_versioned_sidebars/version-5.0.0-sidebars.json new file mode 100644 index 000000000..cff0c94e1 --- /dev/null +++ b/xstate-react-api_versioned_sidebars/version-5.0.0-sidebars.json @@ -0,0 +1,8 @@ +{ + "defaultSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/xstate-react-api_versions.json b/xstate-react-api_versions.json new file mode 100644 index 000000000..b7faebe93 --- /dev/null +++ b/xstate-react-api_versions.json @@ -0,0 +1,3 @@ +[ + "5.0.0" +] From c6fd911a691ec692052199f2b12042aac8133f4c Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Wed, 18 Oct 2023 14:42:32 -0500 Subject: [PATCH 04/43] example per-package versions - next at /api/xstate/next - latest 5.1.0 at /api/xstate - archived 5.0.0 at /api/xstate/5.0.0 --- api/xstate/index.md | 4 ++-- xstate-api_versioned_docs/version-5.0.0/index.md | 4 ++-- xstate-api_versioned_docs/version-5.1.0/index.md | 5 +++++ xstate-api_versioned_sidebars/version-5.1.0-sidebars.json | 8 ++++++++ xstate-api_versions.json | 1 + 5 files changed, 18 insertions(+), 4 deletions(-) create mode 100644 xstate-api_versioned_docs/version-5.1.0/index.md create mode 100644 xstate-api_versioned_sidebars/version-5.1.0-sidebars.json diff --git a/api/xstate/index.md b/api/xstate/index.md index d55fbdafa..f4b7e3ff6 100644 --- a/api/xstate/index.md +++ b/api/xstate/index.md @@ -1,5 +1,5 @@ --- -title: XState API +title: XState API (next) --- -# XState API +# XState API (next) diff --git a/xstate-api_versioned_docs/version-5.0.0/index.md b/xstate-api_versioned_docs/version-5.0.0/index.md index d55fbdafa..e6f97da11 100644 --- a/xstate-api_versioned_docs/version-5.0.0/index.md +++ b/xstate-api_versioned_docs/version-5.0.0/index.md @@ -1,5 +1,5 @@ --- -title: XState API +title: XState API v5.0.0 --- -# XState API +# XState API v5.0.0 diff --git a/xstate-api_versioned_docs/version-5.1.0/index.md b/xstate-api_versioned_docs/version-5.1.0/index.md new file mode 100644 index 000000000..08c5297a5 --- /dev/null +++ b/xstate-api_versioned_docs/version-5.1.0/index.md @@ -0,0 +1,5 @@ +--- +title: XState API 5.1.0 +--- + +# XState API 5.1.0 diff --git a/xstate-api_versioned_sidebars/version-5.1.0-sidebars.json b/xstate-api_versioned_sidebars/version-5.1.0-sidebars.json new file mode 100644 index 000000000..cff0c94e1 --- /dev/null +++ b/xstate-api_versioned_sidebars/version-5.1.0-sidebars.json @@ -0,0 +1,8 @@ +{ + "defaultSidebar": [ + { + "type": "autogenerated", + "dirName": "." + } + ] +} diff --git a/xstate-api_versions.json b/xstate-api_versions.json index b7faebe93..4db3df5c9 100644 --- a/xstate-api_versions.json +++ b/xstate-api_versions.json @@ -1,3 +1,4 @@ [ + "5.1.0", "5.0.0" ] From 4431253bc075f3848661861e5a28f89059cb0e82 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Wed, 18 Oct 2023 15:08:34 -0500 Subject: [PATCH 05/43] hide/show navbar version dropdown per-package --- docusaurus.config.js | 8 ++++++++ src/css/custom.css | 8 ++++++++ 2 files changed, 16 insertions(+) diff --git a/docusaurus.config.js b/docusaurus.config.js index 8a8c797ef..462b41a88 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -192,6 +192,14 @@ const config = { { to: 'blog', label: 'Blog', position: 'right' }, { type: 'docsVersionDropdown', + docsPluginId: 'xstate-api', + className: 'docsVersionDropdown--xstate-api', + position: 'right', + }, + { + type: 'docsVersionDropdown', + docsPluginId: 'xstate-react-api', + className: 'docsVersionDropdown--xstate-react-api', position: 'right', }, { diff --git a/src/css/custom.css b/src/css/custom.css index d263306ed..42cf3e774 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1937,3 +1937,11 @@ span.footer__link-item a:active { width: 1px; white-space: nowrap; } + +/* via https://github.com/facebook/docusaurus/issues/3930#issuecomment-1396833897 */ +html:not(.plugin-id-xstate-api) .docsVersionDropdown--xstate-api { + display: none; +} +html:not(.plugin-id-xstate-react-api) .docsVersionDropdown--xstate-react-api { + display: none; +} From 473bc90a145fc7a8f66dd2ac87fb8dcabae7cf7f Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Wed, 18 Oct 2023 15:08:49 -0500 Subject: [PATCH 06/43] navbar link to xstate API --- docusaurus.config.js | 1 + 1 file changed, 1 insertion(+) diff --git a/docusaurus.config.js b/docusaurus.config.js index 462b41a88..a6fcedf35 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -171,6 +171,7 @@ const config = { position: 'right', }, { to: '/docs', label: 'Docs', position: 'right' }, + { to: '/api/xstate', label: 'API', position: 'right' }, { href: 'https://stately.ai/registry/projects', label: 'Studio', From fb5ef8343a0f612edfeaa146f1a606664b1bd39e Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Wed, 18 Oct 2023 15:16:12 -0500 Subject: [PATCH 07/43] hide parent item --- src/css/custom.css | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/src/css/custom.css b/src/css/custom.css index 42cf3e774..08d45edf4 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1939,9 +1939,9 @@ span.footer__link-item a:active { } /* via https://github.com/facebook/docusaurus/issues/3930#issuecomment-1396833897 */ -html:not(.plugin-id-xstate-api) .docsVersionDropdown--xstate-api { +html:not(.plugin-id-xstate-api) .dropdown:has(.docsVersionDropdown--xstate-api) { display: none; } -html:not(.plugin-id-xstate-react-api) .docsVersionDropdown--xstate-react-api { +html:not(.plugin-id-xstate-react-api) .dropdown:has(.docsVersionDropdown--xstate-react-api) { display: none; } From d748492f7f7476bf587f724e256a166542cc8709 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 12:21:48 -0500 Subject: [PATCH 08/43] add xstate as a submodule --- .gitmodules | 3 +++ xstate | 1 + 2 files changed, 4 insertions(+) create mode 100644 .gitmodules create mode 160000 xstate diff --git a/.gitmodules b/.gitmodules new file mode 100644 index 000000000..6fc5365ce --- /dev/null +++ b/.gitmodules @@ -0,0 +1,3 @@ +[submodule "xstate"] + path = xstate + url = https://github.com/statelyai/xstate diff --git a/xstate b/xstate new file mode 160000 index 000000000..98f9f9165 --- /dev/null +++ b/xstate @@ -0,0 +1 @@ +Subproject commit 98f9f9165df328bba68622b69ec46dada0e3a4f7 From ce79d231fc5d6ac36207d8384c96d89fa1683711 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 12:07:50 -0500 Subject: [PATCH 09/43] define versions for current package api docs --- docusaurus.config.js | 14 ++++++++++++-- src/css/custom.css | 6 ++++-- 2 files changed, 16 insertions(+), 4 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index a6fcedf35..411ca69c8 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -140,7 +140,12 @@ const config = { id: 'xstate-api', path: 'api/xstate', routeBasePath: 'api/xstate', - // sidebarPath: require.resolve('./sidebars.js') + // sidebarPath: require.resolve('./sidebars.js'), + versions: { + current: { + label: 'xstate@5.0.0' + } + } }, ], [ @@ -149,7 +154,12 @@ const config = { id: 'xstate-react-api', path: 'api/@xstate/react', routeBasePath: 'api/@xstate/react', - // sidebarPath: require.resolve('./sidebars.js') + // sidebarPath: require.resolve('./sidebars.js'), + versions: { + current: { + label: '@xstate/react@3.2.2' + } + } } ] ], diff --git a/src/css/custom.css b/src/css/custom.css index 08d45edf4..a4b62ea1e 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1939,9 +1939,11 @@ span.footer__link-item a:active { } /* via https://github.com/facebook/docusaurus/issues/3930#issuecomment-1396833897 */ -html:not(.plugin-id-xstate-api) .dropdown:has(.docsVersionDropdown--xstate-api) { +html:not(.plugin-id-xstate-api) .dropdown:has(.docsVersionDropdown--xstate-api), +html:not(.plugin-id-xstate-api) .docsVersionDropdown--xstate-api { display: none; } -html:not(.plugin-id-xstate-react-api) .dropdown:has(.docsVersionDropdown--xstate-react-api) { +html:not(.plugin-id-xstate-react-api) .dropdown:has(.docsVersionDropdown--xstate-react-api), +html:not(.plugin-id-xstate-react-api) .docsVersionDropdown--xstate-react-api { display: none; } From e36d31d9034b98e9e7523ace0eb39f055c09525a Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 12:08:13 -0500 Subject: [PATCH 10/43] remove example package versions --- xstate-api_versioned_docs/version-5.0.0/index.md | 5 ----- xstate-api_versioned_docs/version-5.1.0/index.md | 5 ----- xstate-api_versioned_sidebars/version-5.0.0-sidebars.json | 8 -------- xstate-api_versioned_sidebars/version-5.1.0-sidebars.json | 8 -------- xstate-api_versions.json | 4 ---- xstate-react-api_versioned_docs/version-5.0.0/index.md | 5 ----- .../version-5.0.0-sidebars.json | 8 -------- xstate-react-api_versions.json | 3 --- 8 files changed, 46 deletions(-) delete mode 100644 xstate-api_versioned_docs/version-5.0.0/index.md delete mode 100644 xstate-api_versioned_docs/version-5.1.0/index.md delete mode 100644 xstate-api_versioned_sidebars/version-5.0.0-sidebars.json delete mode 100644 xstate-api_versioned_sidebars/version-5.1.0-sidebars.json delete mode 100644 xstate-api_versions.json delete mode 100644 xstate-react-api_versioned_docs/version-5.0.0/index.md delete mode 100644 xstate-react-api_versioned_sidebars/version-5.0.0-sidebars.json delete mode 100644 xstate-react-api_versions.json diff --git a/xstate-api_versioned_docs/version-5.0.0/index.md b/xstate-api_versioned_docs/version-5.0.0/index.md deleted file mode 100644 index e6f97da11..000000000 --- a/xstate-api_versioned_docs/version-5.0.0/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: XState API v5.0.0 ---- - -# XState API v5.0.0 diff --git a/xstate-api_versioned_docs/version-5.1.0/index.md b/xstate-api_versioned_docs/version-5.1.0/index.md deleted file mode 100644 index 08c5297a5..000000000 --- a/xstate-api_versioned_docs/version-5.1.0/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: XState API 5.1.0 ---- - -# XState API 5.1.0 diff --git a/xstate-api_versioned_sidebars/version-5.0.0-sidebars.json b/xstate-api_versioned_sidebars/version-5.0.0-sidebars.json deleted file mode 100644 index cff0c94e1..000000000 --- a/xstate-api_versioned_sidebars/version-5.0.0-sidebars.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "defaultSidebar": [ - { - "type": "autogenerated", - "dirName": "." - } - ] -} diff --git a/xstate-api_versioned_sidebars/version-5.1.0-sidebars.json b/xstate-api_versioned_sidebars/version-5.1.0-sidebars.json deleted file mode 100644 index cff0c94e1..000000000 --- a/xstate-api_versioned_sidebars/version-5.1.0-sidebars.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "defaultSidebar": [ - { - "type": "autogenerated", - "dirName": "." - } - ] -} diff --git a/xstate-api_versions.json b/xstate-api_versions.json deleted file mode 100644 index 4db3df5c9..000000000 --- a/xstate-api_versions.json +++ /dev/null @@ -1,4 +0,0 @@ -[ - "5.1.0", - "5.0.0" -] diff --git a/xstate-react-api_versioned_docs/version-5.0.0/index.md b/xstate-react-api_versioned_docs/version-5.0.0/index.md deleted file mode 100644 index 7a67c493e..000000000 --- a/xstate-react-api_versioned_docs/version-5.0.0/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "@xstate/react API" ---- - -# @xstate/react API diff --git a/xstate-react-api_versioned_sidebars/version-5.0.0-sidebars.json b/xstate-react-api_versioned_sidebars/version-5.0.0-sidebars.json deleted file mode 100644 index cff0c94e1..000000000 --- a/xstate-react-api_versioned_sidebars/version-5.0.0-sidebars.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "defaultSidebar": [ - { - "type": "autogenerated", - "dirName": "." - } - ] -} diff --git a/xstate-react-api_versions.json b/xstate-react-api_versions.json deleted file mode 100644 index b7faebe93..000000000 --- a/xstate-react-api_versions.json +++ /dev/null @@ -1,3 +0,0 @@ -[ - "5.0.0" -] From 0ea9cb69b501cd326a8c9e177672bf1d3d68c8b9 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 12:12:07 -0500 Subject: [PATCH 11/43] api docs show version badge on all pages --- docusaurus.config.js | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 411ca69c8..8eb620ce4 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -143,7 +143,8 @@ const config = { // sidebarPath: require.resolve('./sidebars.js'), versions: { current: { - label: 'xstate@5.0.0' + label: 'xstate@5.0.0', + badge: true } } }, @@ -157,7 +158,8 @@ const config = { // sidebarPath: require.resolve('./sidebars.js'), versions: { current: { - label: '@xstate/react@3.2.2' + label: '@xstate/react@3.2.2', + badge: true } } } From c448b65cdea467a1b0e33092474a24527e9f63fb Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 12:53:47 -0500 Subject: [PATCH 12/43] yarn remove docusaurus-plugin-api-extractor --- package.json | 1 - yarn.lock | 310 ++------------------------------------------------- 2 files changed, 12 insertions(+), 299 deletions(-) diff --git a/package.json b/package.json index c5f25fd92..e66b9a586 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,6 @@ "@xstate/machine-extractor": "^0.9.2", "@xstate/react": "^3.2.2", "clsx": "^1.2.1", - "docusaurus-plugin-api-extractor": "^2.0.4", "lucide-react": "^0.129.0", "mdx-embed": "^1.1.2", "prism-react-renderer": "^1.3.5", diff --git a/yarn.lock b/yarn.lock index 8a30684d7..28c2dcf3b 100644 --- a/yarn.lock +++ b/yarn.lock @@ -138,14 +138,6 @@ "@jridgewell/gen-mapping" "^0.1.0" "@jridgewell/trace-mapping" "^0.3.9" -"@ampproject/remapping@^2.2.0": - version "2.2.1" - resolved "https://registry.yarnpkg.com/@ampproject/remapping/-/remapping-2.2.1.tgz#99e8e11851128b8702cd57c33684f1d0f260b630" - integrity sha512-lFMjJTrFL3j7L9yBxwYfCq2k6qqwHyzuUl/XBnif78PWTJYyL/dfowQHWE3sp6U6ZzqWiiIZnpTMO96zhkjwtg== - dependencies: - "@jridgewell/gen-mapping" "^0.3.0" - "@jridgewell/trace-mapping" "^0.3.9" - "@babel/code-frame@^7.0.0", "@babel/code-frame@^7.10.4", "@babel/code-frame@^7.16.0", "@babel/code-frame@^7.18.6", "@babel/code-frame@^7.8.3": version "7.18.6" resolved "https://registry.yarnpkg.com/@babel/code-frame/-/code-frame-7.18.6.tgz#3b25d38c89600baa2dcc219edfa88a74eb2c427a" @@ -165,11 +157,6 @@ resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.18.8.tgz#2483f565faca607b8535590e84e7de323f27764d" integrity sha512-HSmX4WZPPK3FUxYp7g2T6EyO8j96HlZJlxmKPSh6KAcqwyDrfx7hKjXpAW/0FhFfTJsR0Yt4lAjLI2coMptIHQ== -"@babel/compat-data@^7.21.4": - version "7.21.4" - resolved "https://registry.yarnpkg.com/@babel/compat-data/-/compat-data-7.21.4.tgz#457ffe647c480dff59c2be092fc3acf71195c87f" - integrity sha512-/DYyDpeCfaVinT40FPGdkkb+lYSKvsVuMjDAG7jPOWWiM1ibOaB9CXJAlc4d1QpP/U2q2P9jbrSlClKSErd55g== - "@babel/core@7.12.9": version "7.12.9" resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.12.9.tgz#fd450c4ec10cdbb980e2928b7aa7a28484593fc8" @@ -192,27 +179,6 @@ semver "^5.4.1" source-map "^0.5.0" -"@babel/core@^7.0.0": - version "7.21.4" - resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.21.4.tgz#c6dc73242507b8e2a27fd13a9c1814f9fa34a659" - integrity sha512-qt/YV149Jman/6AfmlxJ04LMIu8bMoyl3RB91yTFrxQmgbrSvQMy7cI8Q62FHx1t8wJ8B5fu0UDoLwHAhUo1QA== - dependencies: - "@ampproject/remapping" "^2.2.0" - "@babel/code-frame" "^7.21.4" - "@babel/generator" "^7.21.4" - "@babel/helper-compilation-targets" "^7.21.4" - "@babel/helper-module-transforms" "^7.21.2" - "@babel/helpers" "^7.21.0" - "@babel/parser" "^7.21.4" - "@babel/template" "^7.20.7" - "@babel/traverse" "^7.21.4" - "@babel/types" "^7.21.4" - convert-source-map "^1.7.0" - debug "^4.1.0" - gensync "^1.0.0-beta.2" - json5 "^2.2.2" - semver "^6.3.0" - "@babel/core@^7.18.5", "@babel/core@^7.18.6": version "7.18.9" resolved "https://registry.yarnpkg.com/@babel/core/-/core-7.18.9.tgz#805461f967c77ff46c74ca0460ccf4fe933ddd59" @@ -278,17 +244,6 @@ browserslist "^4.20.2" semver "^6.3.0" -"@babel/helper-compilation-targets@^7.21.4": - version "7.21.4" - resolved "https://registry.yarnpkg.com/@babel/helper-compilation-targets/-/helper-compilation-targets-7.21.4.tgz#770cd1ce0889097ceacb99418ee6934ef0572656" - integrity sha512-Fa0tTuOXZ1iL8IeDFUWCzjZcn+sJGd9RZdH9esYVjEejGmzf+FFYQpMi/kZUk2kPy/q1H3/GPw7np8qar/stfg== - dependencies: - "@babel/compat-data" "^7.21.4" - "@babel/helper-validator-option" "^7.21.0" - browserslist "^4.21.3" - lru-cache "^5.1.1" - semver "^6.3.0" - "@babel/helper-create-class-features-plugin@^7.18.6": version "7.18.9" resolved "https://registry.yarnpkg.com/@babel/helper-create-class-features-plugin/-/helper-create-class-features-plugin-7.18.9.tgz#d802ee16a64a9e824fcbf0a2ffc92f19d58550ce" @@ -385,20 +340,6 @@ "@babel/traverse" "^7.18.9" "@babel/types" "^7.18.9" -"@babel/helper-module-transforms@^7.21.2": - version "7.21.2" - resolved "https://registry.yarnpkg.com/@babel/helper-module-transforms/-/helper-module-transforms-7.21.2.tgz#160caafa4978ac8c00ac66636cb0fa37b024e2d2" - integrity sha512-79yj2AR4U/Oqq/WOV7Lx6hUjau1Zfo4cI+JLAVYeMV5XIlbOhmjEk5ulbTc9fMpmlojzZHkUUxAiK+UKn+hNQQ== - dependencies: - "@babel/helper-environment-visitor" "^7.18.9" - "@babel/helper-module-imports" "^7.18.6" - "@babel/helper-simple-access" "^7.20.2" - "@babel/helper-split-export-declaration" "^7.18.6" - "@babel/helper-validator-identifier" "^7.19.1" - "@babel/template" "^7.20.7" - "@babel/traverse" "^7.21.2" - "@babel/types" "^7.21.2" - "@babel/helper-optimise-call-expression@^7.18.6": version "7.18.6" resolved "https://registry.yarnpkg.com/@babel/helper-optimise-call-expression/-/helper-optimise-call-expression-7.18.6.tgz#9369aa943ee7da47edab2cb4e838acf09d290ffe" @@ -444,13 +385,6 @@ dependencies: "@babel/types" "^7.18.6" -"@babel/helper-simple-access@^7.20.2": - version "7.20.2" - resolved "https://registry.yarnpkg.com/@babel/helper-simple-access/-/helper-simple-access-7.20.2.tgz#0ab452687fe0c2cfb1e2b9e0015de07fc2d62dd9" - integrity sha512-+0woI/WPq59IrqDYbVGfshjT5Dmk/nnbdpcF8SnMhhXObpTq2KNBdLFRFrkVdbDOyUmHBCxzm5FHV1rACIkIbA== - dependencies: - "@babel/types" "^7.20.2" - "@babel/helper-skip-transparent-expression-wrappers@^7.18.9": version "7.18.9" resolved "https://registry.yarnpkg.com/@babel/helper-skip-transparent-expression-wrappers/-/helper-skip-transparent-expression-wrappers-7.18.9.tgz#778d87b3a758d90b471e7b9918f34a9a02eb5818" @@ -485,11 +419,6 @@ resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.18.6.tgz#bf0d2b5a509b1f336099e4ff36e1a63aa5db4db8" integrity sha512-XO7gESt5ouv/LRJdrVjkShckw6STTaB7l9BrpBaAHDeF5YZT+01PCwmR0SJHnkW6i8OwW/EVWRShfi4j2x+KQw== -"@babel/helper-validator-option@^7.21.0": - version "7.21.0" - resolved "https://registry.yarnpkg.com/@babel/helper-validator-option/-/helper-validator-option-7.21.0.tgz#8224c7e13ace4bafdc4004da2cf064ef42673180" - integrity sha512-rmL/B8/f0mKS2baE9ZpyTcTavvEuWhTTW8amjzXNvYG4AwBsqTLikfXsEofsJEfKHf+HQVQbFOHy6o+4cnC/fQ== - "@babel/helper-wrap-function@^7.18.9": version "7.18.9" resolved "https://registry.yarnpkg.com/@babel/helper-wrap-function/-/helper-wrap-function-7.18.9.tgz#ae1feddc6ebbaa2fd79346b77821c3bd73a39646" @@ -509,15 +438,6 @@ "@babel/traverse" "^7.18.9" "@babel/types" "^7.18.9" -"@babel/helpers@^7.21.0": - version "7.21.0" - resolved "https://registry.yarnpkg.com/@babel/helpers/-/helpers-7.21.0.tgz#9dd184fb5599862037917cdc9eecb84577dc4e7e" - integrity sha512-XXve0CBtOW0pd7MRzzmoyuSj0e3SEzj8pgyFxnTT1NJZL38BD1MK7yYrm8yefRPIDvNNe14xR4FdbHwpInD4rA== - dependencies: - "@babel/template" "^7.20.7" - "@babel/traverse" "^7.21.0" - "@babel/types" "^7.21.0" - "@babel/highlight@^7.18.6": version "7.18.6" resolved "https://registry.yarnpkg.com/@babel/highlight/-/highlight-7.18.6.tgz#81158601e93e2563795adcbfbdf5d64be3f2ecdf" @@ -1299,7 +1219,7 @@ debug "^4.1.0" globals "^11.1.0" -"@babel/traverse@^7.21.0", "@babel/traverse@^7.21.2", "@babel/traverse@^7.21.4": +"@babel/traverse@^7.21.4": version "7.21.4" resolved "https://registry.yarnpkg.com/@babel/traverse/-/traverse-7.21.4.tgz#a836aca7b116634e97a6ed99976236b3282c9d36" integrity sha512-eyKrRHKdyZxqDm+fV1iqL9UAHMoIg0nDaGqfIOd8rKH17m5snv7Gn4qgjBoFfLz9APvjFU/ICT00NVCv1Epp8Q== @@ -1323,7 +1243,7 @@ "@babel/helper-validator-identifier" "^7.18.6" to-fast-properties "^2.0.0" -"@babel/types@^7.20.2", "@babel/types@^7.20.7", "@babel/types@^7.21.0", "@babel/types@^7.21.2", "@babel/types@^7.21.4": +"@babel/types@^7.20.7", "@babel/types@^7.21.0", "@babel/types@^7.21.4": version "7.21.4" resolved "https://registry.yarnpkg.com/@babel/types/-/types-7.21.4.tgz#2d5d6bb7908699b3b416409ffd3b5daa25b030d4" integrity sha512-rU2oY501qDxE8Pyo7i/Orqma4ziCOrby0/9mvbDUGEfvZjb279Nk9k19e2fiCxHbRRpY2ZyrgW1eq22mvmOIzA== @@ -1747,20 +1667,6 @@ webpack "^5.73.0" webpack-merge "^5.8.0" -"@docusaurus/types@^2.0.0-beta.6": - version "2.4.0" - resolved "https://registry.yarnpkg.com/@docusaurus/types/-/types-2.4.0.tgz#f94f89a0253778b617c5d40ac6f16b17ec55ce41" - integrity sha512-xaBXr+KIPDkIaef06c+i2HeTqVNixB7yFut5fBXPGI2f1rrmEV2vLMznNGsFwvZ5XmA3Quuefd4OGRkdo97Dhw== - dependencies: - "@types/history" "^4.7.11" - "@types/react" "*" - commander "^5.1.0" - joi "^17.6.0" - react-helmet-async "^1.3.0" - utility-types "^3.10.0" - webpack "^5.73.0" - webpack-merge "^5.8.0" - "@docusaurus/utils-common@2.4.3": version "2.4.3" resolved "https://registry.yarnpkg.com/@docusaurus/utils-common/-/utils-common-2.4.3.tgz#30656c39ef1ce7e002af7ba39ea08330f58efcfb" @@ -1973,11 +1879,6 @@ resolved "https://registry.yarnpkg.com/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz#c3ec604a0b54b9a9b87e9735dfc59e1a5da6a5fb" integrity sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug== -"@microsoft/tsdoc@^0.13.2": - version "0.13.2" - resolved "https://registry.yarnpkg.com/@microsoft/tsdoc/-/tsdoc-0.13.2.tgz#3b0efb6d3903bd49edb073696f60e90df08efb26" - integrity sha512-WrHvO8PDL8wd8T2+zBGKrMwVL5IyzR3ryWUsl0PXgEV0QHup4mTLi0QcATefGI6Gx9Anu7vthPyyyLpY0EpiQg== - "@nodelib/fs.scandir@2.1.5": version "2.1.5" resolved "https://registry.yarnpkg.com/@nodelib/fs.scandir/-/fs.scandir-2.1.5.tgz#7619c2eb21b25483f6d167548b4cfd5a7488c3d5" @@ -2270,18 +2171,6 @@ dependencies: "@types/ms" "*" -"@types/debug@^4.1.7": - version "4.1.7" - resolved "https://registry.yarnpkg.com/@types/debug/-/debug-4.1.7.tgz#7cc0ea761509124709b8b2d1090d8f6c17aadb82" - integrity sha512-9AonUzyTjXXhEOa0DnqpzZi6VHlqKMswga9EXjpXnnqxwLtdvPPtlO8evrI5D9S6asFRCQ6v+wpiUKbw+vKqyg== - dependencies: - "@types/ms" "*" - -"@types/ejs@^3.1.0": - version "3.1.2" - resolved "https://registry.yarnpkg.com/@types/ejs/-/ejs-3.1.2.tgz#75d277b030bc11b3be38c807e10071f45ebc78d9" - integrity sha512-ZmiaE3wglXVWBM9fyVC17aGPkLo/UgaOjEiI2FXQfyczrCefORPxIe+2dVmnmk3zkVIbizjrlQzmPGhSYGXG5g== - "@types/eslint-scope@^3.7.3": version "3.7.4" resolved "https://registry.yarnpkg.com/@types/eslint-scope/-/eslint-scope-3.7.4.tgz#37fc1223f0786c39627068a12e94d6e6fc61de16" @@ -2327,21 +2216,6 @@ "@types/qs" "*" "@types/serve-static" "*" -"@types/fs-extra@^9.0.13": - version "9.0.13" - resolved "https://registry.yarnpkg.com/@types/fs-extra/-/fs-extra-9.0.13.tgz#7594fbae04fe7f1918ce8b3d213f74ff44ac1f45" - integrity sha512-nEnwB++1u5lVDM2UI4c1+5R+FYaKfaAzS4OococimjVm3nQw3TuzH5UNsocrcTBbhnerblyHj4A49qXbIiZdpA== - dependencies: - "@types/node" "*" - -"@types/glob@^7.2.0": - version "7.2.0" - resolved "https://registry.yarnpkg.com/@types/glob/-/glob-7.2.0.tgz#bc1b5bf3aa92f25bd5dd39f35c57361bdce5b2eb" - integrity sha512-ZUxbzKl0IfJILTS6t7ip5fQQM/J3TJYubDm3nMbgubNNYS62eXeUpoLUC8/7fJNiFYHTrGPQn7hspDUzIHX3UA== - dependencies: - "@types/minimatch" "*" - "@types/node" "*" - "@types/hast@^2.0.0": version "2.3.4" resolved "https://registry.yarnpkg.com/@types/hast/-/hast-2.3.4.tgz#8aa5ef92c117d20d974a82bdfb6a648b08c0bafc" @@ -2402,11 +2276,6 @@ resolved "https://registry.yarnpkg.com/@types/mime/-/mime-1.3.2.tgz#93e25bf9ee75fe0fd80b594bc4feb0e862111b5a" integrity sha512-YATxVxgRqNH6nHEIsvg6k2Boc1JHI9ZbH5iWFFv/MTkchz3b1ieGDa5T0a9RznNdI0KhVbdbWSN+KWWrQZRxTw== -"@types/minimatch@*": - version "5.1.2" - resolved "https://registry.yarnpkg.com/@types/minimatch/-/minimatch-5.1.2.tgz#07508b45797cb81ec3f273011b054cd0755eddca" - integrity sha512-K0VQKziLUWkVKiRVrx4a40iPaxTUefQmjtkQofBkYRcoaaL/8rhwDWww9qWbrgicNOgnpIsMxyNIUM4+n6dUIA== - "@types/ms@*": version "0.7.31" resolved "https://registry.yarnpkg.com/@types/ms/-/ms-0.7.31.tgz#31b7ca6407128a3d2bbc27fe2d21b345397f6197" @@ -2417,11 +2286,6 @@ resolved "https://registry.yarnpkg.com/@types/node/-/node-18.6.2.tgz#ffc5f0f099d27887c8d9067b54e55090fcd54126" integrity sha512-KcfkBq9H4PI6Vpu5B/KoPeuVDAbmi+2mDBqGPGUgoL7yXQtcWGu2vJWmmRkneWK3Rh0nIAX192Aa87AqKHYChQ== -"@types/node@^16.10.2": - version "16.18.23" - resolved "https://registry.yarnpkg.com/@types/node/-/node-16.18.23.tgz#b6e934fe427eb7081d0015aad070acb3373c3c90" - integrity sha512-XAMpaw1s1+6zM+jn2tmw8MyaRDIJfXxqmIQIS0HfoGYPuf7dUWeiUKopwq13KFX9lEp1+THGtlaaYx39Nxr58g== - "@types/node@^17.0.5": version "17.0.45" resolved "https://registry.yarnpkg.com/@types/node/-/node-17.0.45.tgz#2c0fafd78705e7a18b7906b5201a522719dc5190" @@ -2442,16 +2306,6 @@ resolved "https://registry.yarnpkg.com/@types/parse5/-/parse5-5.0.3.tgz#e7b5aebbac150f8b5fdd4a46e7f0bd8e65e19109" integrity sha512-kUNnecmtkunAoQ3CnjmMkzNU/gtxG8guhi+Fk2U/kOpIKjIMKnXGp4IJCgQJrXSgMsWYimYG4TGjz/UzbGEBTw== -"@types/pluralize@^0.0.29": - version "0.0.29" - resolved "https://registry.yarnpkg.com/@types/pluralize/-/pluralize-0.0.29.tgz#6ffa33ed1fc8813c469b859681d09707eb40d03c" - integrity sha512-BYOID+l2Aco2nBik+iYS4SZX0Lf20KPILP5RGmM1IgzdwNdTs0eebiFriOPcej1sX9mLnSoiNte5zcFxssgpGA== - -"@types/prettier@^2.4.4": - version "2.7.2" - resolved "https://registry.yarnpkg.com/@types/prettier/-/prettier-2.7.2.tgz#6c2324641cc4ba050a8c710b2b251b377581fbf0" - integrity sha512-KufADq8uQqo1pYKVIYzfKbJfBAc0sOeXqGbFaSpv8MRmC/zXgowNZmFcbngndGk922QDmOASEXUZCaY48gs4cg== - "@types/prop-types@*": version "15.7.5" resolved "https://registry.yarnpkg.com/@types/prop-types/-/prop-types-15.7.5.tgz#5f19d2b85a98e9558036f6a3cacc8819420f05cf" @@ -2551,7 +2405,7 @@ resolved "https://registry.yarnpkg.com/@types/text-table/-/text-table-0.2.3.tgz#c9b0c8df377e10d16795381c2117b718562cae8b" integrity sha512-MUW7DN7e178wJ2dB9rHuhwUWRUJGrl8fCng37BEWV0r2r5VpzkRFRiMfnX6sjXlu4tMn41lrjzsVh/z1XrKc+A== -"@types/unist@*", "@types/unist@^2.0.0", "@types/unist@^2.0.2", "@types/unist@^2.0.3", "@types/unist@^2.0.6": +"@types/unist@*", "@types/unist@^2.0.0", "@types/unist@^2.0.2", "@types/unist@^2.0.3": version "2.0.6" resolved "https://registry.yarnpkg.com/@types/unist/-/unist-2.0.6.tgz#250a7b16c3b91f672a24552ec64678eeb1d3a08d" integrity sha512-PBjIUxZHOuj0R15/xuwJYjFi+KZdNFrehocChv4g5hu6aFroHue8m0lBP0POdK2nKzbw0cgV1mws8+V/JAcEkQ== @@ -2912,11 +2766,6 @@ array-flatten@^2.1.2: resolved "https://registry.yarnpkg.com/array-flatten/-/array-flatten-2.1.2.tgz#24ef80a28c1a893617e2149b0c6d0d788293b099" integrity sha512-hNfzcOV8W4NdualtqBFPyVO+54DSJuZGY9qT4pRroB6S9e3iiido2ISIC5h9R2sPJ8H3FHCIiEnsv1lPXO3KtQ== -array-timsort@^1.0.3: - version "1.0.3" - resolved "https://registry.yarnpkg.com/array-timsort/-/array-timsort-1.0.3.tgz#3c9e4199e54fb2b9c3fe5976396a21614ef0d926" - integrity sha512-/+3GRL7dDAGEfM6TseQk/U+mi18TU2Ms9I3UlLdUMhz2hbvGNTKdj9xniwXfUqgYhHxRx0+8UnKkvlNwVU+cWQ== - array-union@^2.1.0: version "2.1.0" resolved "https://registry.yarnpkg.com/array-union/-/array-union-2.1.0.tgz#b798420adbeb1de828d84acd8a2e23d3efe85e8d" @@ -2944,11 +2793,6 @@ ast-types@^0.16.1: dependencies: tslib "^2.0.1" -async@^3.2.3: - version "3.2.4" - resolved "https://registry.yarnpkg.com/async/-/async-3.2.4.tgz#2d22e00f8cddeb5fde5dd33522b56d1cf569a81c" - integrity sha512-iAB+JbDEGXhyIUavoDl9WP/Jj106Kz9DEn1DPgYw5ruDn0e3Wgi3sKFm55sASdGBNOQB8F59d9qQ7deqrHA8wQ== - at-least-node@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/at-least-node/-/at-least-node-1.0.0.tgz#602cd4b46e844ad4effc92a8011a3c46e0238dc2" @@ -3162,16 +3006,6 @@ browserslist@^4.0.0, browserslist@^4.14.5, browserslist@^4.16.6, browserslist@^4 node-releases "^2.0.6" update-browserslist-db "^1.0.5" -browserslist@^4.21.3: - version "4.21.5" - resolved "https://registry.yarnpkg.com/browserslist/-/browserslist-4.21.5.tgz#75c5dae60063ee641f977e00edd3cfb2fb7af6a7" - integrity sha512-tUkiguQGW7S3IhB7N+c2MV/HZPSCPAAiYBZXLsBhFB/PCy6ZKKsZrmBayHV9fdGV/ARIfJ14NkxKzRDjvp7L6w== - dependencies: - caniuse-lite "^1.0.30001449" - electron-to-chromium "^1.4.284" - node-releases "^2.0.8" - update-browserslist-db "^1.0.10" - buffer-from@^1.0.0: version "1.1.2" resolved "https://registry.yarnpkg.com/buffer-from/-/buffer-from-1.1.2.tgz#2b146a6fd72e80b4f55d255f35ed59a3a9a41bd5" @@ -3241,7 +3075,7 @@ caniuse-api@^3.0.0: lodash.memoize "^4.1.2" lodash.uniq "^4.5.0" -caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001335, caniuse-lite@^1.0.30001370, caniuse-lite@^1.0.30001449: +caniuse-lite@^1.0.0, caniuse-lite@^1.0.30001335, caniuse-lite@^1.0.30001370: version "1.0.30001525" resolved "https://registry.npmjs.org/caniuse-lite/-/caniuse-lite-1.0.30001525.tgz" integrity sha512-/3z+wB4icFt3r0USMwxujAqRvaD/B7rvGTsKhbhSQErVrJvkZCLhgNLJxU8MevahQVH6hCU9FsHdNUFbiwmE7Q== @@ -3260,7 +3094,7 @@ chalk@^2.0.0: escape-string-regexp "^1.0.5" supports-color "^5.3.0" -chalk@^4.0.2, chalk@^4.1.0, chalk@^4.1.2: +chalk@^4.1.0, chalk@^4.1.2: version "4.1.2" resolved "https://registry.yarnpkg.com/chalk/-/chalk-4.1.2.tgz#aac4e2b7734a740867aeb16bf02aad556a1e7a01" integrity sha512-oKnbhFyRIXpUuez8iBMmyEa4nbj4IOQyuhc/wy9kY7/WVPcwIO9VA668Pu8RkO7+0G76SLROeyw9CpQ061i4mA== @@ -3493,17 +3327,6 @@ commander@^8.3.0: resolved "https://registry.yarnpkg.com/commander/-/commander-8.3.0.tgz#4837ea1b2da67b9c616a67afbb0fafee567bca66" integrity sha512-OkTL9umf+He2DZkUq8f8J9of7yL6RJKI24dVITBmNfZBmri9zYZQrKkuXiKhyfPSu8tUhnVBB1iKXevvnlR4Ww== -comment-json@^4.1.1: - version "4.2.3" - resolved "https://registry.yarnpkg.com/comment-json/-/comment-json-4.2.3.tgz#50b487ebbf43abe44431f575ebda07d30d015365" - integrity sha512-SsxdiOf064DWoZLH799Ata6u7iV658A11PlWtZATDlXPpKGJnbJZ5Z24ybixAi+LUUqJ/GKowAejtC5GFUG7Tw== - dependencies: - array-timsort "^1.0.3" - core-util-is "^1.0.3" - esprima "^4.0.1" - has-own-prop "^2.0.0" - repeat-string "^1.6.1" - commondir@^1.0.1: version "1.0.1" resolved "https://registry.yarnpkg.com/commondir/-/commondir-1.0.1.tgz#ddd800da0c66127393cca5950ea968a3aaf1253b" @@ -3650,7 +3473,7 @@ core-js@^3.23.3: resolved "https://registry.yarnpkg.com/core-js/-/core-js-3.24.0.tgz#4928d4e99c593a234eb1a1f9abd3122b04d3ac57" integrity sha512-IeOyT8A6iK37Ep4kZDD423mpi6JfPRoPUdQwEWYiGolvn4o6j2diaRzNfDfpTdu3a5qMbrGUzKUpYpRY8jXCkQ== -core-util-is@^1.0.3, core-util-is@~1.0.0: +core-util-is@~1.0.0: version "1.0.3" resolved "https://registry.yarnpkg.com/core-util-is/-/core-util-is-1.0.3.tgz#a6042d3634c2b27e9328f837b965fac83808db85" integrity sha512-ZQBvi1DcpJ4GDqanjucZ2Hj3wEO5pZDS89BWbkcrvdxksJorwUDDZamX9ldFkp9aw2lmBDLgkObEA4DWNJ9FYQ== @@ -3849,7 +3672,7 @@ date-fns@^2.30.0: dependencies: "@babel/runtime" "^7.21.0" -debug@2.6.9, debug@^2.6.0, debug@^2.6.9: +debug@2.6.9, debug@^2.6.0: version "2.6.9" resolved "https://registry.yarnpkg.com/debug/-/debug-2.6.9.tgz#5d128515df134ff327e90a4c93f4e077a536341f" integrity sha512-bC7ElrdJaJnPbAP+1EotYvqZsb3ecl5wi6Bfi6BJTUcNowp6cvspg0jXznRTKDjm/E7AdgFBVeAPVMNcKGsHMA== @@ -4000,27 +3823,6 @@ dns-packet@^5.2.2: dependencies: "@leichtgewicht/ip-codec" "^2.0.1" -docusaurus-plugin-api-extractor@^2.0.4: - version "2.0.4" - resolved "https://registry.yarnpkg.com/docusaurus-plugin-api-extractor/-/docusaurus-plugin-api-extractor-2.0.4.tgz#10b6257b6441ace6f6a776f87ef2dc5645070958" - integrity sha512-uDFC/PJRmmDKBh2y6PlaNMW0R8v3/7HiqpeL+DcECPfCskEGCLt6Lqds2YvjRHW8hUgLyYaO42vVNTCBuHERzg== - dependencies: - "@babel/core" "^7.0.0" - "@docusaurus/types" "^2.0.0-beta.6" - "@types/debug" "^4.1.7" - "@types/ejs" "^3.1.0" - "@types/fs-extra" "^9.0.13" - "@types/glob" "^7.2.0" - "@types/node" "^16.10.2" - "@types/prettier" "^2.4.4" - comment-json "^4.1.1" - debug "^2.6.9" - ejs "^3.1.6" - fs-extra "^10.0.0" - glob "^7.2.0" - prettier "^2.5.1" - standard-markdown-documenter "0.2.2" - dom-converter@^0.2.0: version "0.2.0" resolved "https://registry.yarnpkg.com/dom-converter/-/dom-converter-0.2.0.tgz#6721a9daee2e293682955b6afe416771627bb768" @@ -4123,23 +3925,11 @@ ee-first@1.1.1: resolved "https://registry.yarnpkg.com/ee-first/-/ee-first-1.1.1.tgz#590c61156b0ae2f4f0255732a158b266bc56b21d" integrity sha512-WMwm9LhRUo+WUaRN+vRuETqG89IgZphVSNkdFgeb6sS/E4OrDIN7t48CAewSHXc6C8lefD8KKfr5vY61brQlow== -ejs@^3.1.6: - version "3.1.9" - resolved "https://registry.yarnpkg.com/ejs/-/ejs-3.1.9.tgz#03c9e8777fe12686a9effcef22303ca3d8eeb361" - integrity sha512-rC+QVNMJWv+MtPgkt0y+0rVEIdbtxVADApW9JXrUVlzHetgcyczP/E7DJmWJ4fJCZF2cPcBk0laWO9ZHMG3DmQ== - dependencies: - jake "^10.8.5" - electron-to-chromium@^1.4.202: version "1.4.204" resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.204.tgz#aae069adea642c066ea95faf5121262b0842e262" integrity sha512-5Ojjtw9/c9HCXtMVE6SXVSHSNjmbFOXpKprl6mY/5moLSxLeWatuYA7KTD+RzJMxLRH6yNNQrqGz9p6IoNBMgw== -electron-to-chromium@^1.4.284: - version "1.4.366" - resolved "https://registry.yarnpkg.com/electron-to-chromium/-/electron-to-chromium-1.4.366.tgz#48d400f9c4af8e80f7bbad0d18730c165d43155e" - integrity sha512-XjC4pyf1no8kJe24nUfyexpWwiGRbZWXU/KbprSEvXcTXUlr3Zr5vK3lQt2to0ttpMhAc3iENccwPSKbnEW2Fg== - emoji-regex@^10.2.1: version "10.2.1" resolved "https://registry.yarnpkg.com/emoji-regex/-/emoji-regex-10.2.1.tgz#a41c330d957191efd3d9dfe6e1e8e1e9ab048b3f" @@ -4245,7 +4035,7 @@ eslint-scope@5.1.1: esrecurse "^4.3.0" estraverse "^4.1.1" -esprima@^4.0.0, esprima@^4.0.1, esprima@~4.0.0: +esprima@^4.0.0, esprima@~4.0.0: version "4.0.1" resolved "https://registry.yarnpkg.com/esprima/-/esprima-4.0.1.tgz#13b04cdb3e6c5d19df91ab6987a8695619b0aa71" integrity sha512-eGuFFw7Upda+g4p+QHvnW0RyTX/SVeJBDM/gCtMARO0cLuT2HcEKnTPvhjV6aGeqrCB/sbNop0Kszm0jsaWU4A== @@ -4451,13 +4241,6 @@ file-loader@^6.2.0: loader-utils "^2.0.0" schema-utils "^3.0.0" -filelist@^1.0.1: - version "1.0.4" - resolved "https://registry.yarnpkg.com/filelist/-/filelist-1.0.4.tgz#f78978a1e944775ff9e62e744424f215e58352b5" - integrity sha512-w1cEuf3S+DrLCQL7ET6kz+gmlJdbq9J7yXCSjK/OZCPA+qEN1WyF4ZAf0YYJa4/shHJra2t/d/r8SV4Ji+x+8Q== - dependencies: - minimatch "^5.0.1" - filesize@^8.0.6: version "8.0.7" resolved "https://registry.yarnpkg.com/filesize/-/filesize-8.0.7.tgz#695e70d80f4e47012c132d57a059e80c6b580bd8" @@ -4577,7 +4360,7 @@ fresh@0.5.2: resolved "https://registry.yarnpkg.com/fresh/-/fresh-0.5.2.tgz#3d8cadd90d976569fa835ab1f8e4b23a105605a7" integrity sha512-zJ2mQYM18rEFOudeV4GShTGIQ7RbzA7ozbU9I/XBpm7kqgMywgmylMwXHxZJmkVoYkna9d2pVXVXPdYTP9ej8Q== -fs-extra@^10.0.0, fs-extra@^10.1.0: +fs-extra@^10.1.0: version "10.1.0" resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-10.1.0.tgz#02873cfbc4084dde127eaa5f9905eef2325d1abf" integrity sha512-oRXApq54ETRj4eMiFzGnHWGy+zo5raudjuxN0b8H7s/RU2oW0Wvsx9O0ACRN/kRq9E8Vu/ReskGB5o3ji+FzHQ== @@ -4723,7 +4506,7 @@ glob@^10.0.0, glob@^10.2.2: minipass "^5.0.0 || ^6.0.2 || ^7.0.0" path-scurry "^1.10.1" -glob@^7.0.0, glob@^7.1.3, glob@^7.1.6, glob@^7.2.0: +glob@^7.0.0, glob@^7.1.3, glob@^7.1.6: version "7.2.3" resolved "https://registry.yarnpkg.com/glob/-/glob-7.2.3.tgz#b8df0fb802bbfa8e89bd1d938b4e16578ed44f2b" integrity sha512-nFR0zLpU2YCaRxwoCJvL6UvCH2JFyFVIvwTLsIf21AuHlMskA1hhTdk+LlYJtOlYt9v6dvszD2BGRqBL+iQK9Q== @@ -4847,11 +4630,6 @@ has-flag@^4.0.0: resolved "https://registry.yarnpkg.com/has-flag/-/has-flag-4.0.0.tgz#944771fd9c81c81265c4d6941860da06bb59479b" integrity sha512-EykJT/Q1KjTWctppgIAgfSO0tKVuZUjhgMr17kqTumMl6Afv3EISleU7qZUzoXDFTAHTDC4NOoG/ZxU3EvlMPQ== -has-own-prop@^2.0.0: - version "2.0.0" - resolved "https://registry.yarnpkg.com/has-own-prop/-/has-own-prop-2.0.0.tgz#f0f95d58f65804f5d218db32563bb85b8e0417af" - integrity sha512-Pq0h+hvsVm6dDEa8x82GnLSYHOzNDt7f0ddFa3FqcQlgzEiptPqL+XrOJNavjOzSYiYWIrgeVYYgGlLmnxwilQ== - has-property-descriptors@^1.0.0: version "1.0.0" resolved "https://registry.yarnpkg.com/has-property-descriptors/-/has-property-descriptors-1.0.0.tgz#610708600606d36961ed04c196193b6a607fa861" @@ -5517,16 +5295,6 @@ jackspeak@^2.3.5: optionalDependencies: "@pkgjs/parseargs" "^0.11.0" -jake@^10.8.5: - version "10.8.5" - resolved "https://registry.yarnpkg.com/jake/-/jake-10.8.5.tgz#f2183d2c59382cb274226034543b9c03b8164c46" - integrity sha512-sVpxYeuAhWt0OTWITwT98oyV0GsXyMlXCF+3L1SuafBVUIr/uILGRB+NqwkzhgXKvoJpDIpQvqkUALgdmQsQxw== - dependencies: - async "^3.2.3" - chalk "^4.0.2" - filelist "^1.0.1" - minimatch "^3.0.4" - jest-worker@^27.4.5, jest-worker@^27.5.1: version "27.5.1" resolved "https://registry.yarnpkg.com/jest-worker/-/jest-worker-27.5.1.tgz#8d146f0900e8973b106b6f73cc1e9a8cb86f8db0" @@ -5607,7 +5375,7 @@ json-schema-traverse@^1.0.0: resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-1.0.0.tgz#ae7bcb3656ab77a73ba5c49bf654f38e6b6860e2" integrity sha512-NM8/P9n3XjXhIZn1lLhkFaACTOURQXjWhV4BA/RnOv8xvgqtqpAX9IO4mRQxSx1Rlo4tqzeqb0sOlruaOy3dug== -json5@^2.0.0, json5@^2.2.2: +json5@^2.0.0: version "2.2.3" resolved "https://registry.yarnpkg.com/json5/-/json5-2.2.3.tgz#78cd6f1a19bdc12b73db5ad0c61efd66c1e29283" integrity sha512-XmOWe7eyHYH14cLdVPoyg+GOH3rYX++KpzrylJwSW98t3Nk+U8XOl8FWKOgwtzdb8lXGf6zYwDUzeHMWfxasyg== @@ -5810,13 +5578,6 @@ lru-cache@^10.0.1, "lru-cache@^9.1.1 || ^10.0.0": resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-10.0.1.tgz#0a3be479df549cca0e5d693ac402ff19537a6b7a" integrity sha512-IJ4uwUTi2qCccrioU6g9g/5rvvVl13bsdczUUcqbciD9iLr095yj8DQKdObriEvuNSx325N1rV1O0sJFszx75g== -lru-cache@^5.1.1: - version "5.1.1" - resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-5.1.1.tgz#1da27e6710271947695daf6848e847f01d84b920" - integrity sha512-KpNARQA3Iwv+jTA0utUVVbrh+Jlrr1Fv0e56GGzAFOXN7dk/FviaDW8LHmK52DlcH4WP2n6gI8vN1aesBFgo9w== - dependencies: - yallist "^3.0.2" - lru-cache@^6.0.0: version "6.0.0" resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94" @@ -6271,13 +6032,6 @@ minimatch@^3.0.4, minimatch@^3.1.1: dependencies: brace-expansion "^1.1.7" -minimatch@^5.0.1: - version "5.1.6" - resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-5.1.6.tgz#1cfcb8cf5522ea69952cd2af95ae09477f122a96" - integrity sha512-lKwV/1brpG6mBUFHtb7NUmtABCb2WZZmm2wNiOA5hAb8VdCS4B3dtMWyvcoViccwAW/COERjXLt0zP1zXUN26g== - dependencies: - brace-expansion "^2.0.1" - minimatch@^9.0.0, minimatch@^9.0.1: version "9.0.3" resolved "https://registry.yarnpkg.com/minimatch/-/minimatch-9.0.3.tgz#a6e00c3de44c3a542bfaae70abfc22420a6da825" @@ -6375,11 +6129,6 @@ node-releases@^2.0.6: resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.6.tgz#8a7088c63a55e493845683ebf3c828d8c51c5503" integrity sha512-PiVXnNuFm5+iYkLBNeq5211hvO38y63T0i2KKh2KnUs3RpzJ+JtODFjkD8yjLwnDkTYF1eKXheUwdssR+NRZdg== -node-releases@^2.0.8: - version "2.0.10" - resolved "https://registry.yarnpkg.com/node-releases/-/node-releases-2.0.10.tgz#c311ebae3b6a148c89b1813fd7c4d3c024ef537f" - integrity sha512-5GFldHPXVG/YZmFzJvKK2zDSzPKhEp0+ZR5SVaoSag9fsL5YgHbUHDfnG5494ISANDcK4KwPXAx2xqVEydmd7w== - nopt@^7.0.0: version "7.2.0" resolved "https://registry.yarnpkg.com/nopt/-/nopt-7.2.0.tgz#067378c68116f602f552876194fd11f1292503d7" @@ -6754,11 +6503,6 @@ pkg-up@^3.1.0: dependencies: find-up "^3.0.0" -pluralize@^8.0.0: - version "8.0.0" - resolved "https://registry.yarnpkg.com/pluralize/-/pluralize-8.0.0.tgz#1a6fa16a38d12a1901e0320fa017051c539ce3b1" - integrity sha512-Nc3IT5yHzflTfbjgqWcCPpo7DaKy4FnpB0l/zCAW0Tc7jxAiuqSxHasntB3D7887LSrA93kDJ9IXovxJYxyLCA== - postcss-calc@^8.2.3: version "8.2.4" resolved "https://registry.yarnpkg.com/postcss-calc/-/postcss-calc-8.2.4.tgz#77b9c29bfcbe8a07ff6693dc87050828889739a5" @@ -7054,11 +6798,6 @@ prepend-http@^2.0.0: resolved "https://registry.yarnpkg.com/prepend-http/-/prepend-http-2.0.0.tgz#e92434bfa5ea8c19f41cdfd401d741a3c819d897" integrity sha512-ravE6m9Atw9Z/jjttRUZ+clIXogdghyZAuWJ3qEzjT+jI/dL1ifAqhZeC5VHzQp1MSt1+jxKkFNemj/iO7tVUA== -prettier@^2.5.1: - version "2.8.7" - resolved "https://registry.yarnpkg.com/prettier/-/prettier-2.8.7.tgz#bb79fc8729308549d28fe3a98fce73d2c0656450" - integrity sha512-yPngTo3aXUUmyuTjeTUT75txrf+aMh9FiD7q9ZE/i6r0bPb22g4FsE6Y338PQX1bmfy08i9QQCB7/rcUAVntfw== - pretty-error@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/pretty-error/-/pretty-error-4.0.0.tgz#90a703f46dd7234adb46d0f84823e9d1cb8f10d6" @@ -7643,7 +7382,7 @@ renderkid@^3.0.0: lodash "^4.17.21" strip-ansi "^6.0.1" -repeat-string@^1.5.4, repeat-string@^1.6.1: +repeat-string@^1.5.4: version "1.6.1" resolved "https://registry.yarnpkg.com/repeat-string/-/repeat-string-1.6.1.tgz#8dcae470e1c88abc2d600fff4a776286da75e637" integrity sha512-PV0dzCYDNfRi1jCDbJzpW7jNNDRuCOG/jI5ctQcGKt/clZD+YcPS3yIlWuTJMmESC8aevCFmWJy5wjAFgNqN6w== @@ -8138,18 +7877,6 @@ stable@^0.1.8: resolved "https://registry.yarnpkg.com/stable/-/stable-0.1.8.tgz#836eb3c8382fe2936feaf544631017ce7d47a3cf" integrity sha512-ji9qxRnOVfcuLDySj9qzhGSEFVobyt1kIOSkj1qZzYLzq7Tos/oUUWvotUPQLlrsidqsK6tBH89Bc9kL5zHA6w== -standard-markdown-documenter@0.2.2: - version "0.2.2" - resolved "https://registry.yarnpkg.com/standard-markdown-documenter/-/standard-markdown-documenter-0.2.2.tgz#f5647188c8768b89ba5399839ccbf7321d1096ca" - integrity sha512-zs7uUkJWQBWYfMmdntyQkYOdWFels+K54j2XC1aEQHi+BV7zSIxdTBOa0lkPdyaNrvvhcdpHhcsuopB2Z5kS2w== - dependencies: - "@microsoft/tsdoc" "^0.13.2" - "@types/debug" "^4.1.7" - "@types/pluralize" "^0.0.29" - "@types/unist" "^2.0.6" - fs-extra "^10.0.0" - pluralize "^8.0.0" - state-toggle@^1.0.0: version "1.0.3" resolved "https://registry.yarnpkg.com/state-toggle/-/state-toggle-1.0.3.tgz#e123b16a88e143139b09c6852221bc9815917dfe" @@ -8738,14 +8465,6 @@ unpipe@1.0.0, unpipe@~1.0.0: resolved "https://registry.yarnpkg.com/unpipe/-/unpipe-1.0.0.tgz#b2bf4ee8514aae6165b4817829d21b2ef49904ec" integrity sha512-pjy2bYhSsufwWlKwPc+l3cN7+wuJlK6uz0YdJEOlQDbl6jo/YlPi4mb8agUkVC8BF7V8NuzeyPNqRksA3hztKQ== -update-browserslist-db@^1.0.10: - version "1.0.11" - resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.0.11.tgz#9a2a641ad2907ae7b3616506f4b977851db5b940" - integrity sha512-dCwEFf0/oT85M1fHBg4F0jtLwJrutGoHSQXCh7u4o2t1drG+c0a9Flnqww6XUKSfQMPpJBRjU8d4RXB09qtvaA== - dependencies: - escalade "^3.1.1" - picocolors "^1.0.0" - update-browserslist-db@^1.0.5: version "1.0.5" resolved "https://registry.yarnpkg.com/update-browserslist-db/-/update-browserslist-db-1.0.5.tgz#be06a5eedd62f107b7c19eb5bcefb194411abf38" @@ -9241,11 +8960,6 @@ y18n@^5.0.5: resolved "https://registry.yarnpkg.com/y18n/-/y18n-5.0.8.tgz#7f4934d0f7ca8c56f95314939ddcd2dd91ce1d55" integrity sha512-0pfFzegeDWJHJIAmTLRP2DwHjdF5s7jo9tuztdQxAhINCdvS+3nGINqPd00AphqJR/0LhANUS6/+7SCb98YOfA== -yallist@^3.0.2: - version "3.1.1" - resolved "https://registry.yarnpkg.com/yallist/-/yallist-3.1.1.tgz#dbb7daf9bfd8bac9ab45ebf602b8cbad0d5d08fd" - integrity sha512-a4UGQaWPH59mOXUYnAG2ewncQS4i4F43Tv3JoAM+s2VDAmS9NsK8GpDMLrCHPksFT7h3K6TOoUNn2pb7RoXx4g== - yallist@^4.0.0: version "4.0.0" resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" From 059d27ce3346efb7d248c3c60ec90731b4ac99be Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 12:59:03 -0500 Subject: [PATCH 13/43] add @microsoft/api-extractor --- package.json | 3 +- yarn.lock | 83 ++++++++++++++++++++++++++++++++-------------------- 2 files changed, 54 insertions(+), 32 deletions(-) diff --git a/package.json b/package.json index e66b9a586..e9de58095 100644 --- a/package.json +++ b/package.json @@ -32,7 +32,8 @@ "@docusaurus/preset-classic": "^2.4.3", "@docusaurus/remark-plugin-npm2yarn": "^2.4.3", "@mdx-js/react": "^1.6.22", - "@microsoft/api-extractor": "^7.35.1", + "@microsoft/api-documenter": "7.23.9", + "@microsoft/api-extractor": "7.38.0", "@xstate/inspect": "^0.8.0", "@xstate/machine-extractor": "^0.9.2", "@xstate/react": "^3.2.2", diff --git a/yarn.lock b/yarn.lock index 28c2dcf3b..445998ccd 100644 --- a/yarn.lock +++ b/yarn.lock @@ -1837,30 +1837,43 @@ resolved "https://registry.yarnpkg.com/@mdx-js/util/-/util-1.6.22.tgz#219dfd89ae5b97a8801f015323ffa4b62f45718b" integrity sha512-H1rQc1ZOHANWBvPcW+JpGwr+juXSxM8Q8YCkm3GhZd8REu1fHR3z99CErO1p9pkcfcxZnMdIZdIsXkOHY0NilA== -"@microsoft/api-extractor-model@7.27.1": - version "7.27.1" - resolved "https://registry.yarnpkg.com/@microsoft/api-extractor-model/-/api-extractor-model-7.27.1.tgz#06a1ba273f1a4b23fe080ba14b80d2e5346abd4f" - integrity sha512-WgmuQwElTuRLATQxCx+pqk5FtUeRX3FW8WDo7tSDmrN/7+XAggeVg5t8ItiJt688jEdbiPvagZlvjAcJMpXspg== +"@microsoft/api-documenter@7.23.9": + version "7.23.9" + resolved "https://registry.yarnpkg.com/@microsoft/api-documenter/-/api-documenter-7.23.9.tgz#4ca0166cb42df253c1c4f99a4ff51d0ff763ea76" + integrity sha512-CvOy3JF0oCDm3GDqce3uFS9QGO72lfOEgVbvpje32O+ug/WoL8ITOg2jZszMtowuClasPbpEcEoVsHJJLePirg== + dependencies: + "@microsoft/api-extractor-model" "7.28.2" + "@microsoft/tsdoc" "0.14.2" + "@rushstack/node-core-library" "3.61.0" + "@rushstack/ts-command-line" "4.16.1" + colors "~1.2.1" + js-yaml "~3.13.1" + resolve "~1.22.1" + +"@microsoft/api-extractor-model@7.28.2": + version "7.28.2" + resolved "https://registry.yarnpkg.com/@microsoft/api-extractor-model/-/api-extractor-model-7.28.2.tgz#91c66dd820ccc70e0c163e06b392d8363f1b9269" + integrity sha512-vkojrM2fo3q4n4oPh4uUZdjJ2DxQ2+RnDQL/xhTWSRUNPF6P4QyrvY357HBxbnltKcYu+nNNolVqc6TIGQ73Ig== dependencies: "@microsoft/tsdoc" "0.14.2" "@microsoft/tsdoc-config" "~0.16.1" - "@rushstack/node-core-library" "3.59.2" + "@rushstack/node-core-library" "3.61.0" -"@microsoft/api-extractor@^7.35.1": - version "7.35.1" - resolved "https://registry.yarnpkg.com/@microsoft/api-extractor/-/api-extractor-7.35.1.tgz#5ae8694ceccd31e117606be9c0093d11bdb10d32" - integrity sha512-xGVf1lKCYKEyJsspLzQjo4Oo6PGDPH95Z5/te75xQWpcRHcfemb6zTSPtiFeVDHkg9Tan5HW2QXGLwQRkW199w== +"@microsoft/api-extractor@7.38.0": + version "7.38.0" + resolved "https://registry.yarnpkg.com/@microsoft/api-extractor/-/api-extractor-7.38.0.tgz#e72546d6766b3866578a462b040f71b17779e1c5" + integrity sha512-e1LhZYnfw+JEebuY2bzhw0imDCl1nwjSThTrQqBXl40hrVo6xm3j/1EpUr89QyzgjqmAwek2ZkIVZbrhaR+cqg== dependencies: - "@microsoft/api-extractor-model" "7.27.1" + "@microsoft/api-extractor-model" "7.28.2" "@microsoft/tsdoc" "0.14.2" "@microsoft/tsdoc-config" "~0.16.1" - "@rushstack/node-core-library" "3.59.2" - "@rushstack/rig-package" "0.3.19" - "@rushstack/ts-command-line" "4.13.3" + "@rushstack/node-core-library" "3.61.0" + "@rushstack/rig-package" "0.5.1" + "@rushstack/ts-command-line" "4.16.1" colors "~1.2.1" lodash "~4.17.15" resolve "~1.22.1" - semver "~7.3.0" + semver "~7.5.4" source-map "~0.6.1" typescript "~5.0.4" @@ -1939,31 +1952,31 @@ resolved "https://registry.yarnpkg.com/@polka/url/-/url-1.0.0-next.21.tgz#5de5a2385a35309427f6011992b544514d559aa1" integrity sha512-a5Sab1C4/icpTZVzZc5Ghpz88yQtGOyNqYXcZgOssB2uuAr+wF/MvN6bgtW32q7HHrvBki+BsZ0OuNv6EV3K9g== -"@rushstack/node-core-library@3.59.2": - version "3.59.2" - resolved "https://registry.yarnpkg.com/@rushstack/node-core-library/-/node-core-library-3.59.2.tgz#3b5823d3f6946e1ed10fcb91ab8c1569f57acf55" - integrity sha512-Od8i9ZXiRPHrnkuNOZ9IjEYRQ9JsBLNHlkWJr1wSQZrD2TVIc8APpIB/FnzEcjfpbJMT4XhtcCZaa0pVx+hTXw== +"@rushstack/node-core-library@3.61.0": + version "3.61.0" + resolved "https://registry.yarnpkg.com/@rushstack/node-core-library/-/node-core-library-3.61.0.tgz#7441a0d2ae5268b758a7a49588a78cd55af57e66" + integrity sha512-tdOjdErme+/YOu4gPed3sFS72GhtWCgNV9oDsHDnoLY5oDfwjKUc9Z+JOZZ37uAxcm/OCahDHfuu2ugqrfWAVQ== dependencies: colors "~1.2.1" fs-extra "~7.0.1" import-lazy "~4.0.0" jju "~1.4.0" resolve "~1.22.1" - semver "~7.3.0" + semver "~7.5.4" z-schema "~5.0.2" -"@rushstack/rig-package@0.3.19": - version "0.3.19" - resolved "https://registry.yarnpkg.com/@rushstack/rig-package/-/rig-package-0.3.19.tgz#635ca524cbb73523af3a0a19b4a0821c61800fdf" - integrity sha512-2d0/Gn+qjOYneZbiHjn4SjyDwq9I0WagV37z0F1V71G+yONgH7wlt3K/UoNiDkhA8gTHYPRo2jz3CvttybwSag== +"@rushstack/rig-package@0.5.1": + version "0.5.1" + resolved "https://registry.yarnpkg.com/@rushstack/rig-package/-/rig-package-0.5.1.tgz#6c9c283cc96b5bb1eae9875946d974ac5429bb21" + integrity sha512-pXRYSe29TjRw7rqxD4WS3HN/sRSbfr+tJs4a9uuaSIBAITbUggygdhuG0VrO0EO+QqH91GhYMN4S6KRtOEmGVA== dependencies: resolve "~1.22.1" strip-json-comments "~3.1.1" -"@rushstack/ts-command-line@4.13.3": - version "4.13.3" - resolved "https://registry.yarnpkg.com/@rushstack/ts-command-line/-/ts-command-line-4.13.3.tgz#39c1cd4b0a8d86a6552a7a0635671f164a22d904" - integrity sha512-6aQIv/o1EgsC/+SpgUyRmzg2QIAL6sudEzw3sWzJKwWuQTc5XRsyZpyldfE7WAmIqMXDao9QG35/NYORjHm5Zw== +"@rushstack/ts-command-line@4.16.1": + version "4.16.1" + resolved "https://registry.yarnpkg.com/@rushstack/ts-command-line/-/ts-command-line-4.16.1.tgz#3537bbc323f77c8646646465c579b992d39feb16" + integrity sha512-+OCsD553GYVLEmz12yiFjMOzuPeCiZ3f8wTiFHL30ZVXexTyPmgjwXEhg2K2P0a2lVf+8YBy7WtPoflB2Fp8/A== dependencies: "@types/argparse" "1.0.38" argparse "~1.0.9" @@ -5340,6 +5353,14 @@ js-yaml@^4.1.0: dependencies: argparse "^2.0.1" +js-yaml@~3.13.1: + version "3.13.1" + resolved "https://registry.yarnpkg.com/js-yaml/-/js-yaml-3.13.1.tgz#aff151b30bfdfa8e49e05da22e7415e9dfa37847" + integrity sha512-YfbcO7jXDdyj0DGxYVSlSeQNHbD7XPWvrVWeVUujrQEoZzWJIRrCPoyk6kL6IAjAG2IolMK4T0hNUe0HOUs5Jw== + dependencies: + argparse "^1.0.7" + esprima "^4.0.0" + jsesc@^2.5.1: version "2.5.2" resolved "https://registry.yarnpkg.com/jsesc/-/jsesc-2.5.2.tgz#80564d2e483dacf6e8ef209650a67df3f0c283a4" @@ -7616,10 +7637,10 @@ semver@^7.3.2, semver@^7.3.4, semver@^7.3.5, semver@^7.3.7: dependencies: lru-cache "^6.0.0" -semver@~7.3.0: - version "7.3.8" - resolved "https://registry.yarnpkg.com/semver/-/semver-7.3.8.tgz#07a78feafb3f7b32347d725e33de7e2a2df67798" - integrity sha512-NB1ctGL5rlHrPJtFDVIVzTyQylMLu9N9VICA6HSFJo8MCGVTMW6gfpicwKmmK/dAjTOrqu5l63JJOpDSrAis3A== +semver@~7.5.4: + version "7.5.4" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.5.4.tgz#483986ec4ed38e1c6c48c34894a9182dbff68a6e" + integrity sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA== dependencies: lru-cache "^6.0.0" From 9f0ba1b3b8f41695a8b34325e50aa1762d69eaeb Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 13:01:41 -0500 Subject: [PATCH 14/43] add scripts/update-api-docs.sh --- scripts/update-api-docs.sh | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) create mode 100755 scripts/update-api-docs.sh diff --git a/scripts/update-api-docs.sh b/scripts/update-api-docs.sh new file mode 100755 index 000000000..b1f50ec91 --- /dev/null +++ b/scripts/update-api-docs.sh @@ -0,0 +1,19 @@ +#!/bin/bash +set -e + +# enter the xstate submodule +cd xstate +# check out the latest version +git co next +# install dependencies +yarn +# build .d.ts +yarn build +# enter the core package +cd packages/core +# run API Extractor to generate temp/xstate.api.json +../../../node_modules/@microsoft/api-extractor/bin/api-extractor run --local --diagnostics +# go back to the docs git root +cd ../../.. +# run API Documenter to generate API Docs Markdown +./node_modules/@microsoft/api-documenter/bin/api-documenter markdown --input-folder ./xstate/packages/core/temp --output-folder ./api/xstate From 1abc880b44a9d77075d72cdf544ae2cfc9e6e5dd Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 13:10:38 -0500 Subject: [PATCH 15/43] README.md: describe the API docs script --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 8fe4ff767..5880c38d6 100644 --- a/README.md +++ b/README.md @@ -31,6 +31,16 @@ Currently we serve the root landing page from a static file. - During server side rendering (SSR) we use [`/static/index.html`](./static/index.html) - During client side rendering (CSR) we use [`/static/landing-page/index.html`](./static/landing-page/index.html) +## Updating API Documentation + +``` +$ scripts/update-api-docs.sh +``` + +This command generates API Documentation as Markdown files to the `api` directory. + +It uses [API Extractor](https://api-extractor.com) to analyze code and inline TSDoc comments from xstate packages, creating `*.api.json` doc model files, which are then used by [API Documenter](https://api-extractor.com/pages/setup/generating_docs) to generate Markdown files in the appropriate `api` directory for each package. We use the [Docusaurus Multi-Instance](https://docusaurus.io/docs/docs-multi-instance) feature to configure each `api/*` directory as its own set of versionable docs. + ## Build ``` From c43356ee3494d18922c03e66fcfcb56cde5ff299 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 14:43:04 -0500 Subject: [PATCH 16/43] disable Docusaurus breadcrumbs for API docs the breadcrumbs generated in Markdown by api-documenter are more precise --- docusaurus.config.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/docusaurus.config.js b/docusaurus.config.js index 8eb620ce4..7ce7cda79 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -141,6 +141,7 @@ const config = { path: 'api/xstate', routeBasePath: 'api/xstate', // sidebarPath: require.resolve('./sidebars.js'), + breadcrumbs: false, versions: { current: { label: 'xstate@5.0.0', @@ -156,6 +157,7 @@ const config = { path: 'api/@xstate/react', routeBasePath: 'api/@xstate/react', // sidebarPath: require.resolve('./sidebars.js'), + breadcrumbs: false, versions: { current: { label: '@xstate/react@3.2.2', From 014f7019a56d12240b5a80ae8ab51d0527042ad7 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 15:17:01 -0500 Subject: [PATCH 17/43] remove @xstate/react docs instance --- docusaurus.config.js | 16 ---------------- 1 file changed, 16 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 7ce7cda79..4c36d8dd1 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -149,22 +149,6 @@ const config = { } } }, - ], - [ - '@docusaurus/plugin-content-docs', - { - id: 'xstate-react-api', - path: 'api/@xstate/react', - routeBasePath: 'api/@xstate/react', - // sidebarPath: require.resolve('./sidebars.js'), - breadcrumbs: false, - versions: { - current: { - label: '@xstate/react@3.2.2', - badge: true - } - } - } ] ], From c39ab9409146d19ce02af1faaaab15cfa626d0c3 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 15:21:35 -0500 Subject: [PATCH 18/43] maintain per-package api-extractor.json in config --- config/xstate.api-extractor.json | 427 +++++++++++++++++++++++++++++++ scripts/update-api-docs.sh | 2 +- 2 files changed, 428 insertions(+), 1 deletion(-) create mode 100644 config/xstate.api-extractor.json diff --git a/config/xstate.api-extractor.json b/config/xstate.api-extractor.json new file mode 100644 index 000000000..046f9f53a --- /dev/null +++ b/config/xstate.api-extractor.json @@ -0,0 +1,427 @@ +/** + * Config file for API Extractor. For more info, please visit: https://api-extractor.com + */ +{ + "$schema": "https://developer.microsoft.com/json-schemas/api-extractor/v7/api-extractor.schema.json", + + /** + * Optionally specifies another JSON config file that this file extends from. This provides a way for + * standard settings to be shared across multiple projects. + * + * If the path starts with "./" or "../", the path is resolved relative to the folder of the file that contains + * the "extends" field. Otherwise, the first path segment is interpreted as an NPM package name, and will be + * resolved using NodeJS require(). + * + * SUPPORTED TOKENS: none + * DEFAULT VALUE: "" + */ + // "extends": "./shared/api-extractor-base.json" + // "extends": "my-package/include/api-extractor-base.json" + + /** + * Determines the "" token that can be used with other config file settings. The project folder + * typically contains the tsconfig.json and package.json config files, but the path is user-defined. + * + * The path is resolved relative to the folder of the config file that contains the setting. + * + * The default value for "projectFolder" is the token "", which means the folder is determined by traversing + * parent folders, starting from the folder containing api-extractor.json, and stopping at the first folder + * that contains a tsconfig.json file. If a tsconfig.json file cannot be found in this way, then an error + * will be reported. + * + * SUPPORTED TOKENS: + * DEFAULT VALUE: "" + */ + "projectFolder": "../xstate/packages/core", + + /** + * (REQUIRED) Specifies the .d.ts file to be used as the starting point for analysis. API Extractor + * analyzes the symbols exported by this module. + * + * The file extension must be ".d.ts" and not ".ts". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + */ + "mainEntryPointFilePath": "../xstate/packages/core/dist/declarations/src/index.d.ts", + + /** + * A list of NPM package names whose exports should be treated as part of this package. + * + * For example, suppose that Webpack is used to generate a distributed bundle for the project "library1", + * and another NPM package "library2" is embedded in this bundle. Some types from library2 may become part + * of the exported API for library1, but by default API Extractor would generate a .d.ts rollup that explicitly + * imports library2. To avoid this, we can specify: + * + * "bundledPackages": [ "library2" ], + * + * This would direct API Extractor to embed those types directly in the .d.ts rollup, as if they had been + * local files for library1. + */ + "bundledPackages": [], + + /** + * Specifies what type of newlines API Extractor should use when writing output files. By default, the output files + * will be written with Windows-style newlines. To use POSIX-style newlines, specify "lf" instead. + * To use the OS's default newline kind, specify "os". + * + * DEFAULT VALUE: "crlf" + */ + // "newlineKind": "crlf", + + /** + * Set to true when invoking API Extractor's test harness. When `testMode` is true, the `toolVersion` field in the + * .api.json file is assigned an empty string to prevent spurious diffs in output files tracked for tests. + * + * DEFAULT VALUE: "false" + */ + // "testMode": false, + + /** + * Specifies how API Extractor sorts members of an enum when generating the .api.json file. By default, the output + * files will be sorted alphabetically, which is "by-name". To keep the ordering in the source code, specify + * "preserve". + * + * DEFAULT VALUE: "by-name" + */ + // "enumMemberOrder": "by-name", + + /** + * Determines how the TypeScript compiler engine will be invoked by API Extractor. + */ + "compiler": { + /** + * Specifies the path to the tsconfig.json file to be used by API Extractor when analyzing the project. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * Note: This setting will be ignored if "overrideTsconfig" is used. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/tsconfig.json" + */ + "tsconfigFilePath": "/../../tsconfig.json", + /** + * Provides a compiler configuration that will be used instead of reading the tsconfig.json file from disk. + * The object must conform to the TypeScript tsconfig schema: + * + * http://json.schemastore.org/tsconfig + * + * If omitted, then the tsconfig.json file will be read from the "projectFolder". + * + * DEFAULT VALUE: no overrideTsconfig section + */ + // "overrideTsconfig": { + // . . . + // } + /** + * This option causes the compiler to be invoked with the --skipLibCheck option. This option is not recommended + * and may cause API Extractor to produce incomplete or incorrect declarations, but it may be required when + * dependencies contain declarations that are incompatible with the TypeScript engine that API Extractor uses + * for its analysis. Where possible, the underlying issue should be fixed rather than relying on skipLibCheck. + * + * DEFAULT VALUE: false + */ + // "skipLibCheck": true, + }, + + /** + * Configures how the API report file (*.api.md) will be generated. + */ + "apiReport": { + /** + * (REQUIRED) Whether to generate an API report. + */ + "enabled": false + + /** + * The filename for the API report files. It will be combined with "reportFolder" or "reportTempFolder" to produce + * a full file path. + * + * The file extension should be ".api.md", and the string should not contain a path separator such as "\" or "/". + * + * SUPPORTED TOKENS: , + * DEFAULT VALUE: ".api.md" + */ + // "reportFileName": ".api.md", + + /** + * Specifies the folder where the API report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * The API report file is normally tracked by Git. Changes to it can be used to trigger a branch policy, + * e.g. for an API review. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/" + */ + // "reportFolder": "/temp/", + + /** + * Specifies the folder where the temporary report file is written. The file name portion is determined by + * the "reportFileName" setting. + * + * After the temporary file is written to disk, it is compared with the file in the "reportFolder". + * If they are different, a production build will fail. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/" + */ + // "reportTempFolder": "/temp/", + + /** + * Whether "forgotten exports" should be included in the API report file. Forgotten exports are declarations + * flagged with `ae-forgotten-export` warnings. See https://api-extractor.com/pages/messages/ae-forgotten-export/ to + * learn more. + * + * DEFAULT VALUE: "false" + */ + // "includeForgottenExports": false + }, + + /** + * Configures how the doc model file (*.api.json) will be generated. + */ + "docModel": { + /** + * (REQUIRED) Whether to generate a doc model file. + */ + "enabled": true + + /** + * The output path for the doc model file. The file extension should be ".api.json". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/temp/.api.json" + */ + // "apiJsonFilePath": "/temp/.api.json", + + /** + * Whether "forgotten exports" should be included in the doc model file. Forgotten exports are declarations + * flagged with `ae-forgotten-export` warnings. See https://api-extractor.com/pages/messages/ae-forgotten-export/ to + * learn more. + * + * DEFAULT VALUE: "false" + */ + // "includeForgottenExports": false, + + /** + * The base URL where the project's source code can be viewed on a website such as GitHub or + * Azure DevOps. This URL path corresponds to the `` path on disk. + * + * This URL is concatenated with the file paths serialized to the doc model to produce URL file paths to individual API items. + * For example, if the `projectFolderUrl` is "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor" and an API + * item's file path is "api/ExtractorConfig.ts", the full URL file path would be + * "https://github.com/microsoft/rushstack/tree/main/apps/api-extractor/api/ExtractorConfig.js". + * + * Can be omitted if you don't need source code links in your API documentation reference. + * + * SUPPORTED TOKENS: none + * DEFAULT VALUE: "" + */ + // "projectFolderUrl": "http://github.com/path/to/your/projectFolder" + }, + + /** + * Configures how the .d.ts rollup file will be generated. + */ + "dtsRollup": { + /** + * (REQUIRED) Whether to generate the .d.ts rollup file. + */ + "enabled": false + + /** + * Specifies the output path for a .d.ts rollup file to be generated without any trimming. + * This file will include all declarations that are exported by the main entry point. + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "/dist/.d.ts" + */ + // "untrimmedFilePath": "/dist/.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for an "alpha" release. + * This file will include only declarations that are marked as "@public", "@beta", or "@alpha". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "alphaTrimmedFilePath": "/dist/-alpha.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "beta" release. + * This file will include only declarations that are marked as "@public" or "@beta". + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "betaTrimmedFilePath": "/dist/-beta.d.ts", + + /** + * Specifies the output path for a .d.ts rollup file to be generated with trimming for a "public" release. + * This file will include only declarations that are marked as "@public". + * + * If the path is an empty string, then this file will not be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "publicTrimmedFilePath": "/dist/-public.d.ts", + + /** + * When a declaration is trimmed, by default it will be replaced by a code comment such as + * "Excluded from this release type: exampleMember". Set "omitTrimmingComments" to true to remove the + * declaration completely. + * + * DEFAULT VALUE: false + */ + // "omitTrimmingComments": true + }, + + /** + * Configures how the tsdoc-metadata.json file will be generated. + */ + "tsdocMetadata": { + /** + * Whether to generate the tsdoc-metadata.json file. + * + * DEFAULT VALUE: true + */ + // "enabled": true, + /** + * Specifies where the TSDoc metadata file should be written. + * + * The path is resolved relative to the folder of the config file that contains the setting; to change this, + * prepend a folder token such as "". + * + * The default value is "", which causes the path to be automatically inferred from the "tsdocMetadata", + * "typings" or "main" fields of the project's package.json. If none of these fields are set, the lookup + * falls back to "tsdoc-metadata.json" in the package folder. + * + * SUPPORTED TOKENS: , , + * DEFAULT VALUE: "" + */ + // "tsdocMetadataFilePath": "/dist/tsdoc-metadata.json" + }, + + /** + * Configures how API Extractor reports error and warning messages produced during analysis. + * + * There are three sources of messages: compiler messages, API Extractor messages, and TSDoc messages. + */ + "messages": { + /** + * Configures handling of diagnostic messages reported by the TypeScript compiler engine while analyzing + * the input .d.ts files. + * + * TypeScript message identifiers start with "TS" followed by an integer. For example: "TS2551" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "compilerMessageReporting": { + /** + * Configures the default routing for messages that don't match an explicit rule in this table. + */ + "default": { + /** + * Specifies whether the message should be written to the the tool's output log. Note that + * the "addToApiReportFile" property may supersede this option. + * + * Possible values: "error", "warning", "none" + * + * Errors cause the build to fail and return a nonzero exit code. Warnings cause a production build fail + * and return a nonzero exit code. For a non-production build (e.g. when "api-extractor run" includes + * the "--local" option), the warning is displayed but the build will not fail. + * + * DEFAULT VALUE: "warning" + */ + "logLevel": "warning" + + /** + * When addToApiReportFile is true: If API Extractor is configured to write an API report file (.api.md), + * then the message will be written inside that file; otherwise, the message is instead logged according to + * the "logLevel" option. + * + * DEFAULT VALUE: false + */ + // "addToApiReportFile": false + } + + // "TS2551": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by API Extractor during its analysis. + * + * API Extractor message identifiers start with "ae-". For example: "ae-extra-release-tag" + * + * DEFAULT VALUE: See api-extractor-defaults.json for the complete table of extractorMessageReporting mappings + */ + "extractorMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "ae-extra-release-tag": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + }, + + /** + * Configures handling of messages reported by the TSDoc parser when analyzing code comments. + * + * TSDoc message identifiers start with "tsdoc-". For example: "tsdoc-link-tag-unescaped-text" + * + * DEFAULT VALUE: A single "default" entry with logLevel=warning. + */ + "tsdocMessageReporting": { + "default": { + "logLevel": "warning" + // "addToApiReportFile": false + } + + // "tsdoc-link-tag-unescaped-text": { + // "logLevel": "warning", + // "addToApiReportFile": true + // }, + // + // . . . + } + } +} diff --git a/scripts/update-api-docs.sh b/scripts/update-api-docs.sh index b1f50ec91..3b6fa8c92 100755 --- a/scripts/update-api-docs.sh +++ b/scripts/update-api-docs.sh @@ -12,7 +12,7 @@ yarn build # enter the core package cd packages/core # run API Extractor to generate temp/xstate.api.json -../../../node_modules/@microsoft/api-extractor/bin/api-extractor run --local --diagnostics +../../../node_modules/@microsoft/api-extractor/bin/api-extractor run --config ../../../config/xstate.api-extractor.json --local --diagnostics # go back to the docs git root cd ../../.. # run API Documenter to generate API Docs Markdown From a0bbc410eef5e41f149ba8522e88d2b9fce6e261 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 15:31:55 -0500 Subject: [PATCH 19/43] generate api.json to project root --- config/xstate.api-extractor.json | 4 ++-- scripts/update-api-docs.sh | 2 +- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/config/xstate.api-extractor.json b/config/xstate.api-extractor.json index 046f9f53a..54f3acf75 100644 --- a/config/xstate.api-extractor.json +++ b/config/xstate.api-extractor.json @@ -195,7 +195,7 @@ /** * (REQUIRED) Whether to generate a doc model file. */ - "enabled": true + "enabled": true, /** * The output path for the doc model file. The file extension should be ".api.json". @@ -206,7 +206,7 @@ * SUPPORTED TOKENS: , , * DEFAULT VALUE: "/temp/.api.json" */ - // "apiJsonFilePath": "/temp/.api.json", + "apiJsonFilePath": "../temp/xstate/xstate.api.json" /** * Whether "forgotten exports" should be included in the doc model file. Forgotten exports are declarations diff --git a/scripts/update-api-docs.sh b/scripts/update-api-docs.sh index 3b6fa8c92..67653b47e 100755 --- a/scripts/update-api-docs.sh +++ b/scripts/update-api-docs.sh @@ -16,4 +16,4 @@ cd packages/core # go back to the docs git root cd ../../.. # run API Documenter to generate API Docs Markdown -./node_modules/@microsoft/api-documenter/bin/api-documenter markdown --input-folder ./xstate/packages/core/temp --output-folder ./api/xstate +./node_modules/@microsoft/api-documenter/bin/api-documenter markdown --input-folder ./temp/xstate --output-folder ./api/xstate From 171e563cc3b1ab644a5929b5c52abab0a6ad0cd9 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 15:35:44 -0500 Subject: [PATCH 20/43] don't generate tsdoc-metadata.json --- config/xstate.api-extractor.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/config/xstate.api-extractor.json b/config/xstate.api-extractor.json index 54f3acf75..704b212a2 100644 --- a/config/xstate.api-extractor.json +++ b/config/xstate.api-extractor.json @@ -314,7 +314,7 @@ * * DEFAULT VALUE: true */ - // "enabled": true, + "enabled": false, /** * Specifies where the TSDoc metadata file should be written. * From 3c60ca281d4e789a3ef1e57335fc5894ca3ecaad Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 15:37:15 -0500 Subject: [PATCH 21/43] update-api-docs: remove temp folder when complete --- scripts/update-api-docs.sh | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/scripts/update-api-docs.sh b/scripts/update-api-docs.sh index 67653b47e..d1cc0ffdd 100755 --- a/scripts/update-api-docs.sh +++ b/scripts/update-api-docs.sh @@ -17,3 +17,7 @@ cd packages/core cd ../../.. # run API Documenter to generate API Docs Markdown ./node_modules/@microsoft/api-documenter/bin/api-documenter markdown --input-folder ./temp/xstate --output-folder ./api/xstate +# remove temporary API Extractor doc model file +rm temp/xstate/xstate.api.json +rmdir temp/xstate +rmdir temp From cb225b1a6d82c5e0fb8a72bac6893a26e14a7600 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 15:37:45 -0500 Subject: [PATCH 22/43] .gitignore: add temp/ --- .gitignore | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/.gitignore b/.gitignore index 06b5b751f..2a767c771 100644 --- a/.gitignore +++ b/.gitignore @@ -30,3 +30,7 @@ yarn-error.log* # JetBrains IDE's .idea .fleet + +# API Extractor temporary files +temp/ + From 4faad9282f20197605968e391eabc381b6793024 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 15:42:59 -0500 Subject: [PATCH 23/43] remove example index.md --- api/xstate/index.md | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 api/xstate/index.md diff --git a/api/xstate/index.md b/api/xstate/index.md deleted file mode 100644 index f4b7e3ff6..000000000 --- a/api/xstate/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: XState API (next) ---- - -# XState API (next) From 590cab90a8db51692f2f7832e313547a7c2e7abc Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 16:17:39 -0500 Subject: [PATCH 24/43] comment out unused version dropdown css --- src/css/custom.css | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/css/custom.css b/src/css/custom.css index a4b62ea1e..f8c90859b 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1943,7 +1943,10 @@ html:not(.plugin-id-xstate-api) .dropdown:has(.docsVersionDropdown--xstate-api), html:not(.plugin-id-xstate-api) .docsVersionDropdown--xstate-api { display: none; } +/* TODO per-package overrides can go here */ +/* html:not(.plugin-id-xstate-react-api) .dropdown:has(.docsVersionDropdown--xstate-react-api), html:not(.plugin-id-xstate-react-api) .docsVersionDropdown--xstate-react-api { display: none; } +*/ From 60d199da7f74f90b47a0b1964fd49f0c73884394 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 16:57:31 -0500 Subject: [PATCH 25/43] workaround to fix api extractor generated name without this, api extractor will find package.json a level up and use the name/canonicalReference "stately-docs" instead of "xstate" --- config/package.json | 3 +++ 1 file changed, 3 insertions(+) create mode 100644 config/package.json diff --git a/config/package.json b/config/package.json new file mode 100644 index 000000000..9c39567e7 --- /dev/null +++ b/config/package.json @@ -0,0 +1,3 @@ +{ + "name": "xstate" +} From 8a1fdd596541fb61b097d8c043326f4d5a1755b9 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Thu, 19 Oct 2023 22:36:07 -0500 Subject: [PATCH 26/43] remove example @xstate/react docsVersionDropdown --- docusaurus.config.js | 6 ------ 1 file changed, 6 deletions(-) diff --git a/docusaurus.config.js b/docusaurus.config.js index 4c36d8dd1..4aaa79d59 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -195,12 +195,6 @@ const config = { className: 'docsVersionDropdown--xstate-api', position: 'right', }, - { - type: 'docsVersionDropdown', - docsPluginId: 'xstate-react-api', - className: 'docsVersionDropdown--xstate-react-api', - position: 'right', - }, { type: 'html', position: 'right', From 4026b270d01035a20ada71661e17ff7ed46db01a Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Fri, 20 Oct 2023 10:49:31 -0500 Subject: [PATCH 27/43] remove unused example index --- api/@xstate/react/index.md | 5 ----- 1 file changed, 5 deletions(-) delete mode 100644 api/@xstate/react/index.md diff --git a/api/@xstate/react/index.md b/api/@xstate/react/index.md deleted file mode 100644 index 7a67c493e..000000000 --- a/api/@xstate/react/index.md +++ /dev/null @@ -1,5 +0,0 @@ ---- -title: "@xstate/react API" ---- - -# @xstate/react API From fc9ffc1b4356a1ccf5859fdbccda44209b8647db Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Fri, 20 Oct 2023 12:09:56 -0500 Subject: [PATCH 28/43] WIP plugin to improve sidebar and breadcrumbs --- config/api-documenter.json | 10 + docusaurus.config.js | 4 +- scripts/update-api-docs.sh | 2 +- sidebar-xstate-api.js | 5 + sidebar-xstate-api.json | 2962 +++++++++++++++++ .../.gitignore | 2 + .../package.json | 15 + .../src/DocusaurusMarkdownFeature.ts | 129 + .../src/index.ts | 16 + .../tsconfig.json | 28 + .../yarn.lock | 212 ++ 11 files changed, 3382 insertions(+), 3 deletions(-) create mode 100644 config/api-documenter.json create mode 100644 sidebar-xstate-api.js create mode 100644 sidebar-xstate-api.json create mode 100644 tools/xstate-api-documenter-docusaurus-plugin/.gitignore create mode 100644 tools/xstate-api-documenter-docusaurus-plugin/package.json create mode 100644 tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.ts create mode 100644 tools/xstate-api-documenter-docusaurus-plugin/src/index.ts create mode 100644 tools/xstate-api-documenter-docusaurus-plugin/tsconfig.json create mode 100644 tools/xstate-api-documenter-docusaurus-plugin/yarn.lock diff --git a/config/api-documenter.json b/config/api-documenter.json new file mode 100644 index 000000000..847b29804 --- /dev/null +++ b/config/api-documenter.json @@ -0,0 +1,10 @@ +{ + "outputTarget": "markdown", + + "plugins": [ + { + "packageName": "../tools/xstate-api-documenter-docusaurus-plugin", + "enabledFeatureNames": ["docusaurus-markdown-documenter"] + } + ] +} diff --git a/docusaurus.config.js b/docusaurus.config.js index 4aaa79d59..a5fc3dd30 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -140,8 +140,8 @@ const config = { id: 'xstate-api', path: 'api/xstate', routeBasePath: 'api/xstate', - // sidebarPath: require.resolve('./sidebars.js'), - breadcrumbs: false, + sidebarPath: require.resolve('./sidebar-xstate-api.js'), + breadcrumbs: true, versions: { current: { label: 'xstate@5.0.0', diff --git a/scripts/update-api-docs.sh b/scripts/update-api-docs.sh index d1cc0ffdd..be69c2882 100755 --- a/scripts/update-api-docs.sh +++ b/scripts/update-api-docs.sh @@ -16,7 +16,7 @@ cd packages/core # go back to the docs git root cd ../../.. # run API Documenter to generate API Docs Markdown -./node_modules/@microsoft/api-documenter/bin/api-documenter markdown --input-folder ./temp/xstate --output-folder ./api/xstate +./node_modules/@microsoft/api-documenter/bin/api-documenter generate --input-folder ./temp/xstate --output-folder ./api/xstate # remove temporary API Extractor doc model file rm temp/xstate/xstate.api.json rmdir temp/xstate diff --git a/sidebar-xstate-api.js b/sidebar-xstate-api.js new file mode 100644 index 000000000..bcf60851e --- /dev/null +++ b/sidebar-xstate-api.js @@ -0,0 +1,5 @@ +module.exports = { + sidebar: [ + require('./sidebar-xstate-api.json') + ] +}; diff --git a/sidebar-xstate-api.json b/sidebar-xstate-api.json new file mode 100644 index 000000000..aebdffd36 --- /dev/null +++ b/sidebar-xstate-api.json @@ -0,0 +1,2962 @@ +[ + { + "type": "category", + "label": "xstate", + "link": { + "type": "doc", + "id": "xstate" + }, + "items": [ + { + "type": "doc", + "label": "__ResolvedTypesMetaFrom", + "id": "xstate.__resolvedtypesmetafrom" + }, + { + "type": "doc", + "label": "Action", + "id": "xstate.action" + }, + { + "type": "category", + "label": "ActionArgs", + "link": { + "type": "doc", + "id": "xstate.actionargs" + }, + "items": [ + { + "type": "doc", + "label": "action", + "id": "xstate.actionargs.action" + } + ] + }, + { + "type": "doc", + "label": "ActionFunction", + "id": "xstate.actionfunction" + }, + { + "type": "doc", + "label": "ActionFunctionMap", + "id": "xstate.actionfunctionmap" + }, + { + "type": "doc", + "label": "Actions", + "id": "xstate.actions" + }, + { + "type": "category", + "label": "Actor", + "link": { + "type": "doc", + "id": "xstate.actor" + }, + "items": [ + { + "type": "doc", + "label": "_parent", + "id": "xstate.actor._parent" + }, + { + "type": "doc", + "label": "[symbolObservable]", + "id": "xstate.actor._symbolobservable_" + }, + { + "type": "doc", + "label": "(constructor)", + "id": "xstate.actor._constructor_" + }, + { + "type": "doc", + "label": "cancel", + "id": "xstate.actor.cancel" + }, + { + "type": "doc", + "label": "clock", + "id": "xstate.actor.clock" + }, + { + "type": "doc", + "label": "delaySend", + "id": "xstate.actor.delaysend" + }, + { + "type": "doc", + "label": "getPersistedState", + "id": "xstate.actor.getpersistedstate" + }, + { + "type": "doc", + "label": "getSnapshot", + "id": "xstate.actor.getsnapshot" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.actor.id" + }, + { + "type": "doc", + "label": "logic", + "id": "xstate.actor.logic" + }, + { + "type": "doc", + "label": "options", + "id": "xstate.actor.options" + }, + { + "type": "doc", + "label": "ref", + "id": "xstate.actor.ref" + }, + { + "type": "doc", + "label": "send", + "id": "xstate.actor.send" + }, + { + "type": "doc", + "label": "sessionId", + "id": "xstate.actor.sessionid" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.actor.src" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.actor.start" + }, + { + "type": "doc", + "label": "status", + "id": "xstate.actor.status" + }, + { + "type": "doc", + "label": "stop", + "id": "xstate.actor.stop" + }, + { + "type": "doc", + "label": "subscribe", + "id": "xstate.actor.subscribe" + }, + { + "type": "doc", + "label": "subscribe", + "id": "xstate.actor.subscribe_1" + }, + { + "type": "doc", + "label": "system", + "id": "xstate.actor.system" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.actor.tojson" + } + ] + }, + { + "type": "category", + "label": "ActorContext", + "link": { + "type": "doc", + "id": "xstate.actorcontext" + }, + "items": [ + { + "type": "doc", + "label": "defer", + "id": "xstate.actorcontext.defer" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.actorcontext.id" + }, + { + "type": "doc", + "label": "logger", + "id": "xstate.actorcontext.logger" + }, + { + "type": "doc", + "label": "self", + "id": "xstate.actorcontext.self" + }, + { + "type": "doc", + "label": "sessionId", + "id": "xstate.actorcontext.sessionid" + }, + { + "type": "doc", + "label": "stopChild", + "id": "xstate.actorcontext.stopchild" + }, + { + "type": "doc", + "label": "system", + "id": "xstate.actorcontext.system" + } + ] + }, + { + "type": "category", + "label": "ActorLike", + "link": { + "type": "doc", + "id": "xstate.actorlike" + }, + "items": [ + { + "type": "doc", + "label": "send", + "id": "xstate.actorlike.send" + } + ] + }, + { + "type": "category", + "label": "ActorLogic", + "link": { + "type": "doc", + "id": "xstate.actorlogic" + }, + "items": [ + { + "type": "doc", + "label": "config", + "id": "xstate.actorlogic.config" + }, + { + "type": "doc", + "label": "getInitialState", + "id": "xstate.actorlogic.getinitialstate" + }, + { + "type": "doc", + "label": "getPersistedState", + "id": "xstate.actorlogic.getpersistedstate" + }, + { + "type": "doc", + "label": "restoreState", + "id": "xstate.actorlogic.restorestate" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.actorlogic.start" + }, + { + "type": "doc", + "label": "transition", + "id": "xstate.actorlogic.transition" + } + ] + }, + { + "type": "doc", + "label": "ActorLogicFrom", + "id": "xstate.actorlogicfrom" + }, + { + "type": "category", + "label": "ActorOptions", + "link": { + "type": "doc", + "id": "xstate.actoroptions" + }, + "items": [ + { + "type": "doc", + "label": "clock", + "id": "xstate.actoroptions.clock" + }, + { + "type": "doc", + "label": "devTools", + "id": "xstate.actoroptions.devtools" + }, + { + "type": "doc", + "label": "execute", + "id": "xstate.actoroptions.execute" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.actoroptions.id" + }, + { + "type": "doc", + "label": "input", + "id": "xstate.actoroptions.input" + }, + { + "type": "doc", + "label": "inspect", + "id": "xstate.actoroptions.inspect" + }, + { + "type": "doc", + "label": "logger", + "id": "xstate.actoroptions.logger" + }, + { + "type": "doc", + "label": "parent", + "id": "xstate.actoroptions.parent" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.actoroptions.src" + }, + { + "type": "doc", + "label": "state", + "id": "xstate.actoroptions.state" + }, + { + "type": "doc", + "label": "sync", + "id": "xstate.actoroptions.sync" + }, + { + "type": "doc", + "label": "systemId", + "id": "xstate.actoroptions.systemid" + } + ] + }, + { + "type": "category", + "label": "ActorRef", + "link": { + "type": "doc", + "id": "xstate.actorref" + }, + "items": [ + { + "type": "doc", + "label": "_parent", + "id": "xstate.actorref._parent" + }, + { + "type": "doc", + "label": "getPersistedState", + "id": "xstate.actorref.getpersistedstate" + }, + { + "type": "doc", + "label": "getSnapshot", + "id": "xstate.actorref.getsnapshot" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.actorref.id" + }, + { + "type": "doc", + "label": "send", + "id": "xstate.actorref.send" + }, + { + "type": "doc", + "label": "sessionId", + "id": "xstate.actorref.sessionid" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.actorref.src" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.actorref.start" + }, + { + "type": "doc", + "label": "status", + "id": "xstate.actorref.status" + }, + { + "type": "doc", + "label": "stop", + "id": "xstate.actorref.stop" + }, + { + "type": "doc", + "label": "system", + "id": "xstate.actorref.system" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.actorref.tojson" + } + ] + }, + { + "type": "doc", + "label": "ActorRefFrom", + "id": "xstate.actorreffrom" + }, + { + "type": "doc", + "label": "ActorStatus", + "id": "xstate.actorstatus" + }, + { + "type": "category", + "label": "ActorSystem", + "link": { + "type": "doc", + "id": "xstate.actorsystem" + }, + "items": [ + { + "type": "doc", + "label": "get", + "id": "xstate.actorsystem.get" + }, + { + "type": "doc", + "label": "inspect", + "id": "xstate.actorsystem.inspect" + } + ] + }, + { + "type": "category", + "label": "ActorSystemInfo", + "link": { + "type": "doc", + "id": "xstate.actorsysteminfo" + }, + "items": [ + { + "type": "doc", + "label": "actors", + "id": "xstate.actorsysteminfo.actors" + } + ] + }, + { + "type": "doc", + "label": "and", + "id": "xstate.and" + }, + { + "type": "doc", + "label": "AnyActor", + "id": "xstate.anyactor" + }, + { + "type": "doc", + "label": "AnyActorContext", + "id": "xstate.anyactorcontext" + }, + { + "type": "doc", + "label": "AnyActorLogic", + "id": "xstate.anyactorlogic" + }, + { + "type": "doc", + "label": "AnyActorRef", + "id": "xstate.anyactorref" + }, + { + "type": "doc", + "label": "AnyActorSystem", + "id": "xstate.anyactorsystem" + }, + { + "type": "doc", + "label": "AnyEventObject", + "id": "xstate.anyeventobject" + }, + { + "type": "doc", + "label": "AnyFunction", + "id": "xstate.anyfunction" + }, + { + "type": "doc", + "label": "AnyHistoryValue", + "id": "xstate.anyhistoryvalue" + }, + { + "type": "doc", + "label": "AnyInterpreter", + "id": "xstate.anyinterpreter" + }, + { + "type": "doc", + "label": "AnyInvokeConfig", + "id": "xstate.anyinvokeconfig" + }, + { + "type": "doc", + "label": "AnyState", + "id": "xstate.anystate" + }, + { + "type": "doc", + "label": "AnyStateConfig", + "id": "xstate.anystateconfig" + }, + { + "type": "doc", + "label": "AnyStateMachine", + "id": "xstate.anystatemachine" + }, + { + "type": "doc", + "label": "AnyStateNode", + "id": "xstate.anystatenode" + }, + { + "type": "doc", + "label": "AnyStateNodeConfig", + "id": "xstate.anystatenodeconfig" + }, + { + "type": "doc", + "label": "AnyStateNodeDefinition", + "id": "xstate.anystatenodedefinition" + }, + { + "type": "doc", + "label": "AnyTransitionConfig", + "id": "xstate.anytransitionconfig" + }, + { + "type": "doc", + "label": "AnyTransitionDefinition", + "id": "xstate.anytransitiondefinition" + }, + { + "type": "doc", + "label": "AreAllImplementationsAssumedToBeProvided", + "id": "xstate.areallimplementationsassumedtobeprovided" + }, + { + "type": "doc", + "label": "assign", + "id": "xstate.assign" + }, + { + "type": "category", + "label": "AssignAction", + "link": { + "type": "doc", + "id": "xstate.assignaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TActor", + "id": "xstate.assignaction._out_tactor" + } + ] + }, + { + "type": "category", + "label": "AssignArgs", + "link": { + "type": "doc", + "id": "xstate.assignargs" + }, + "items": [ + { + "type": "doc", + "label": "spawn", + "id": "xstate.assignargs.spawn" + } + ] + }, + { + "type": "doc", + "label": "Assigner", + "id": "xstate.assigner" + }, + { + "type": "category", + "label": "AtomicStateNodeConfig", + "link": { + "type": "doc", + "id": "xstate.atomicstatenodeconfig" + }, + "items": [ + { + "type": "doc", + "label": "initial", + "id": "xstate.atomicstatenodeconfig.initial" + }, + { + "type": "doc", + "label": "onDone", + "id": "xstate.atomicstatenodeconfig.ondone" + }, + { + "type": "doc", + "label": "parallel", + "id": "xstate.atomicstatenodeconfig.parallel" + }, + { + "type": "doc", + "label": "states", + "id": "xstate.atomicstatenodeconfig.states" + } + ] + }, + { + "type": "category", + "label": "BaseActorRef", + "link": { + "type": "doc", + "id": "xstate.baseactorref" + }, + "items": [ + { + "type": "doc", + "label": "send", + "id": "xstate.baseactorref.send" + } + ] + }, + { + "type": "doc", + "label": "CallbackActorLogic", + "id": "xstate.callbackactorlogic" + }, + { + "type": "doc", + "label": "cancel", + "id": "xstate.cancel" + }, + { + "type": "doc", + "label": "CancelAction", + "id": "xstate.cancelaction" + }, + { + "type": "doc", + "label": "Cast", + "id": "xstate.cast" + }, + { + "type": "doc", + "label": "choose", + "id": "xstate.choose" + }, + { + "type": "category", + "label": "ChooseAction", + "link": { + "type": "doc", + "id": "xstate.chooseaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TAction", + "id": "xstate.chooseaction._out_taction" + }, + { + "type": "doc", + "label": "_out_TActor", + "id": "xstate.chooseaction._out_tactor" + }, + { + "type": "doc", + "label": "_out_TDelay", + "id": "xstate.chooseaction._out_tdelay" + }, + { + "type": "doc", + "label": "_out_TGuard", + "id": "xstate.chooseaction._out_tguard" + } + ] + }, + { + "type": "category", + "label": "ChooseBranch", + "link": { + "type": "doc", + "id": "xstate.choosebranch" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.choosebranch.actions" + }, + { + "type": "doc", + "label": "guard", + "id": "xstate.choosebranch.guard" + } + ] + }, + { + "type": "doc", + "label": "Compute", + "id": "xstate.compute" + }, + { + "type": "doc", + "label": "ContextFactory", + "id": "xstate.contextfactory" + }, + { + "type": "doc", + "label": "ContextFrom", + "id": "xstate.contextfrom" + }, + { + "type": "doc", + "label": "createActor", + "id": "xstate.createactor" + }, + { + "type": "doc", + "label": "createActor", + "id": "xstate.createactor_1" + }, + { + "type": "doc", + "label": "createEmptyActor", + "id": "xstate.createemptyactor" + }, + { + "type": "doc", + "label": "createMachine", + "id": "xstate.createmachine" + }, + { + "type": "doc", + "label": "DelayConfig", + "id": "xstate.delayconfig" + }, + { + "type": "category", + "label": "DelayedTransitionDefinition", + "link": { + "type": "doc", + "id": "xstate.delayedtransitiondefinition" + }, + "items": [ + { + "type": "doc", + "label": "delay", + "id": "xstate.delayedtransitiondefinition.delay" + } + ] + }, + { + "type": "doc", + "label": "DelayedTransitions", + "id": "xstate.delayedtransitions" + }, + { + "type": "doc", + "label": "DelayExpr", + "id": "xstate.delayexpr" + }, + { + "type": "doc", + "label": "DelayFunctionMap", + "id": "xstate.delayfunctionmap" + }, + { + "type": "doc", + "label": "DevToolsAdapter", + "id": "xstate.devtoolsadapter" + }, + { + "type": "category", + "label": "DoneActorEvent", + "link": { + "type": "doc", + "id": "xstate.doneactorevent" + }, + "items": [ + { + "type": "doc", + "label": "output", + "id": "xstate.doneactorevent.output" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.doneactorevent.type" + } + ] + }, + { + "type": "category", + "label": "DoneStateEvent", + "link": { + "type": "doc", + "id": "xstate.donestateevent" + }, + "items": [ + { + "type": "doc", + "label": "output", + "id": "xstate.donestateevent.output" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.donestateevent.type" + } + ] + }, + { + "type": "doc", + "label": "Equals", + "id": "xstate.equals" + }, + { + "type": "category", + "label": "ErrorActorEvent", + "link": { + "type": "doc", + "id": "xstate.erroractorevent" + }, + "items": [ + { + "type": "doc", + "label": "data", + "id": "xstate.erroractorevent.data" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.erroractorevent.type" + } + ] + }, + { + "type": "doc", + "label": "escalate", + "id": "xstate.escalate" + }, + { + "type": "doc", + "label": "EventDescriptor", + "id": "xstate.eventdescriptor" + }, + { + "type": "doc", + "label": "EventFrom", + "id": "xstate.eventfrom" + }, + { + "type": "doc", + "label": "EventFromLogic", + "id": "xstate.eventfromlogic" + }, + { + "type": "category", + "label": "EventObject", + "link": { + "type": "doc", + "id": "xstate.eventobject" + }, + "items": [ + { + "type": "doc", + "label": "type", + "id": "xstate.eventobject.type" + } + ] + }, + { + "type": "doc", + "label": "ExtractEvent", + "id": "xstate.extractevent" + }, + { + "type": "doc", + "label": "forwardTo", + "id": "xstate.forwardto" + }, + { + "type": "doc", + "label": "fromCallback", + "id": "xstate.fromcallback" + }, + { + "type": "doc", + "label": "fromEventObservable", + "id": "xstate.fromeventobservable" + }, + { + "type": "doc", + "label": "fromObservable", + "id": "xstate.fromobservable" + }, + { + "type": "doc", + "label": "fromPromise", + "id": "xstate.frompromise" + }, + { + "type": "doc", + "label": "fromTransition", + "id": "xstate.fromtransition" + }, + { + "type": "doc", + "label": "getStateNodes", + "id": "xstate.getstatenodes" + }, + { + "type": "category", + "label": "HistoryStateNode", + "link": { + "type": "doc", + "id": "xstate.historystatenode" + }, + "items": [ + { + "type": "doc", + "label": "history", + "id": "xstate.historystatenode.history" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.historystatenode.target" + } + ] + }, + { + "type": "category", + "label": "HistoryStateNodeConfig", + "link": { + "type": "doc", + "id": "xstate.historystatenodeconfig" + }, + "items": [ + { + "type": "doc", + "label": "history", + "id": "xstate.historystatenodeconfig.history" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.historystatenodeconfig.target" + } + ] + }, + { + "type": "doc", + "label": "HistoryValue", + "id": "xstate.historyvalue" + }, + { + "type": "doc", + "label": "HomomorphicOmit", + "id": "xstate.homomorphicomit" + }, + { + "type": "doc", + "label": "HomomorphicPick", + "id": "xstate.homomorphicpick" + }, + { + "type": "doc", + "label": "IndexByProp", + "id": "xstate.indexbyprop" + }, + { + "type": "doc", + "label": "IndexByType", + "id": "xstate.indexbytype" + }, + { + "type": "doc", + "label": "InferEvent", + "id": "xstate.inferevent" + }, + { + "type": "category", + "label": "InitialTransitionConfig", + "link": { + "type": "doc", + "id": "xstate.initialtransitionconfig" + }, + "items": [ + { + "type": "doc", + "label": "target", + "id": "xstate.initialtransitionconfig.target" + } + ] + }, + { + "type": "category", + "label": "InitialTransitionDefinition", + "link": { + "type": "doc", + "id": "xstate.initialtransitiondefinition" + }, + "items": [ + { + "type": "doc", + "label": "guard", + "id": "xstate.initialtransitiondefinition.guard" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.initialtransitiondefinition.target" + } + ] + }, + { + "type": "doc", + "label": "InputFrom", + "id": "xstate.inputfrom" + }, + { + "type": "category", + "label": "InspectedActorEvent", + "link": { + "type": "doc", + "id": "xstate.inspectedactorevent" + }, + "items": [ + { + "type": "doc", + "label": "actorRef", + "id": "xstate.inspectedactorevent.actorref" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.inspectedactorevent.type" + } + ] + }, + { + "type": "category", + "label": "InspectedEventEvent", + "link": { + "type": "doc", + "id": "xstate.inspectedeventevent" + }, + "items": [ + { + "type": "doc", + "label": "event", + "id": "xstate.inspectedeventevent.event" + }, + { + "type": "doc", + "label": "sourceRef", + "id": "xstate.inspectedeventevent.sourceref" + }, + { + "type": "doc", + "label": "targetRef", + "id": "xstate.inspectedeventevent.targetref" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.inspectedeventevent.type" + } + ] + }, + { + "type": "category", + "label": "InspectedSnapshotEvent", + "link": { + "type": "doc", + "id": "xstate.inspectedsnapshotevent" + }, + "items": [ + { + "type": "doc", + "label": "actorRef", + "id": "xstate.inspectedsnapshotevent.actorref" + }, + { + "type": "doc", + "label": "event", + "id": "xstate.inspectedsnapshotevent.event" + }, + { + "type": "doc", + "label": "snapshot", + "id": "xstate.inspectedsnapshotevent.snapshot" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.inspectedsnapshotevent.type" + } + ] + }, + { + "type": "doc", + "label": "InspectionEvent", + "id": "xstate.inspectionevent" + }, + { + "type": "doc", + "label": "InternalMachineImplementations", + "id": "xstate.internalmachineimplementations" + }, + { + "type": "category", + "label": "InteropObservable", + "link": { + "type": "doc", + "id": "xstate.interopobservable" + }, + "items": [ + { + "type": "doc", + "label": "[Symbol.observable]", + "id": "xstate.interopobservable._symbol.observable_" + } + ] + }, + { + "type": "category", + "label": "InteropSubscribable", + "link": { + "type": "doc", + "id": "xstate.interopsubscribable" + }, + "items": [ + { + "type": "doc", + "label": "subscribe", + "id": "xstate.interopsubscribable.subscribe" + } + ] + }, + { + "type": "doc", + "label": "interpret", + "id": "xstate.interpret" + }, + { + "type": "doc", + "label": "Interpreter", + "id": "xstate.interpreter" + }, + { + "type": "doc", + "label": "InterpreterFrom", + "id": "xstate.interpreterfrom" + }, + { + "type": "doc", + "label": "InterpreterStatus", + "id": "xstate.interpreterstatus" + }, + { + "type": "doc", + "label": "InvokeConfig", + "id": "xstate.invokeconfig" + }, + { + "type": "category", + "label": "InvokeDefinition", + "link": { + "type": "doc", + "id": "xstate.invokedefinition" + }, + "items": [ + { + "type": "doc", + "label": "id", + "id": "xstate.invokedefinition.id" + }, + { + "type": "doc", + "label": "input", + "id": "xstate.invokedefinition.input" + }, + { + "type": "doc", + "label": "onDone", + "id": "xstate.invokedefinition.ondone" + }, + { + "type": "doc", + "label": "onError", + "id": "xstate.invokedefinition.onerror" + }, + { + "type": "doc", + "label": "onSnapshot", + "id": "xstate.invokedefinition.onsnapshot" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.invokedefinition.src" + }, + { + "type": "doc", + "label": "systemId", + "id": "xstate.invokedefinition.systemid" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.invokedefinition.tojson" + } + ] + }, + { + "type": "doc", + "label": "IsAny", + "id": "xstate.isany" + }, + { + "type": "doc", + "label": "IsLiteralString", + "id": "xstate.isliteralstring" + }, + { + "type": "doc", + "label": "IsNever", + "id": "xstate.isnever" + }, + { + "type": "doc", + "label": "Lazy", + "id": "xstate.lazy" + }, + { + "type": "doc", + "label": "log", + "id": "xstate.log" + }, + { + "type": "doc", + "label": "LogAction", + "id": "xstate.logaction" + }, + { + "type": "doc", + "label": "LogExpr", + "id": "xstate.logexpr" + }, + { + "type": "doc", + "label": "LowInfer", + "id": "xstate.lowinfer" + }, + { + "type": "doc", + "label": "MachineConfig", + "id": "xstate.machineconfig" + }, + { + "type": "doc", + "label": "MachineContext", + "id": "xstate.machinecontext" + }, + { + "type": "doc", + "label": "MachineImplementations", + "id": "xstate.machineimplementations" + }, + { + "type": "doc", + "label": "MachineImplementationsFrom", + "id": "xstate.machineimplementationsfrom" + }, + { + "type": "category", + "label": "MachineImplementationsSimplified", + "link": { + "type": "doc", + "id": "xstate.machineimplementationssimplified" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.machineimplementationssimplified.actions" + }, + { + "type": "doc", + "label": "actors", + "id": "xstate.machineimplementationssimplified.actors" + }, + { + "type": "doc", + "label": "delays", + "id": "xstate.machineimplementationssimplified.delays" + }, + { + "type": "doc", + "label": "guards", + "id": "xstate.machineimplementationssimplified.guards" + } + ] + }, + { + "type": "doc", + "label": "MachineSnapshot", + "id": "xstate.machinesnapshot" + }, + { + "type": "category", + "label": "MachineTypes", + "link": { + "type": "doc", + "id": "xstate.machinetypes" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.machinetypes.actions" + }, + { + "type": "doc", + "label": "actors", + "id": "xstate.machinetypes.actors" + }, + { + "type": "doc", + "label": "context", + "id": "xstate.machinetypes.context" + }, + { + "type": "doc", + "label": "delays", + "id": "xstate.machinetypes.delays" + }, + { + "type": "doc", + "label": "events", + "id": "xstate.machinetypes.events" + }, + { + "type": "doc", + "label": "guards", + "id": "xstate.machinetypes.guards" + }, + { + "type": "doc", + "label": "input", + "id": "xstate.machinetypes.input" + }, + { + "type": "doc", + "label": "output", + "id": "xstate.machinetypes.output" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.machinetypes.tags" + }, + { + "type": "doc", + "label": "typegen", + "id": "xstate.machinetypes.typegen" + } + ] + }, + { + "type": "doc", + "label": "Mapper", + "id": "xstate.mapper" + }, + { + "type": "doc", + "label": "mapState", + "id": "xstate.mapstate" + }, + { + "type": "category", + "label": "MarkAllImplementationsAsProvided", + "link": { + "type": "doc", + "id": "xstate.markallimplementationsasprovided" + }, + "items": [ + { + "type": "doc", + "label": "\"@@xstate/typegen\"", + "id": "xstate.markallimplementationsasprovided.___xstate_typegen_" + }, + { + "type": "doc", + "label": "resolved", + "id": "xstate.markallimplementationsasprovided.resolved" + } + ] + }, + { + "type": "doc", + "label": "matchesState", + "id": "xstate.matchesstate" + }, + { + "type": "doc", + "label": "MaybeLazy", + "id": "xstate.maybelazy" + }, + { + "type": "doc", + "label": "Merge", + "id": "xstate.merge" + }, + { + "type": "doc", + "label": "MetaObject", + "id": "xstate.metaobject" + }, + { + "type": "doc", + "label": "MissingImplementationsError", + "id": "xstate.missingimplementationserror" + }, + { + "type": "doc", + "label": "NoInfer", + "id": "xstate.noinfer" + }, + { + "type": "doc", + "label": "NonReducibleUnknown", + "id": "xstate.nonreducibleunknown" + }, + { + "type": "doc", + "label": "NoRequiredParams", + "id": "xstate.norequiredparams" + }, + { + "type": "doc", + "label": "not", + "id": "xstate.not" + }, + { + "type": "doc", + "label": "ObservableActorLogic", + "id": "xstate.observableactorlogic" + }, + { + "type": "doc", + "label": "Observer", + "id": "xstate.observer" + }, + { + "type": "doc", + "label": "or", + "id": "xstate.or" + }, + { + "type": "doc", + "label": "OutputFrom", + "id": "xstate.outputfrom" + }, + { + "type": "category", + "label": "ParameterizedObject", + "link": { + "type": "doc", + "id": "xstate.parameterizedobject" + }, + "items": [ + { + "type": "doc", + "label": "params", + "id": "xstate.parameterizedobject.params" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.parameterizedobject.type" + } + ] + }, + { + "type": "doc", + "label": "PartialAssigner", + "id": "xstate.partialassigner" + }, + { + "type": "doc", + "label": "pathToStateValue", + "id": "xstate.pathtostatevalue" + }, + { + "type": "doc", + "label": "PersistedMachineState", + "id": "xstate.persistedmachinestate" + }, + { + "type": "doc", + "label": "PersistedStateFrom", + "id": "xstate.persistedstatefrom" + }, + { + "type": "doc", + "label": "PromiseActorLogic", + "id": "xstate.promiseactorlogic" + }, + { + "type": "doc", + "label": "Prop", + "id": "xstate.prop" + }, + { + "type": "doc", + "label": "PropertyAssigner", + "id": "xstate.propertyassigner" + }, + { + "type": "category", + "label": "ProvidedActor", + "link": { + "type": "doc", + "id": "xstate.providedactor" + }, + "items": [ + { + "type": "doc", + "label": "id", + "id": "xstate.providedactor.id" + }, + { + "type": "doc", + "label": "logic", + "id": "xstate.providedactor.logic" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.providedactor.src" + } + ] + }, + { + "type": "doc", + "label": "pure", + "id": "xstate.pure" + }, + { + "type": "category", + "label": "PureAction", + "link": { + "type": "doc", + "id": "xstate.pureaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TAction", + "id": "xstate.pureaction._out_taction" + }, + { + "type": "doc", + "label": "_out_TActor", + "id": "xstate.pureaction._out_tactor" + }, + { + "type": "doc", + "label": "_out_TDelay", + "id": "xstate.pureaction._out_tdelay" + }, + { + "type": "doc", + "label": "_out_TEvent", + "id": "xstate.pureaction._out_tevent" + }, + { + "type": "doc", + "label": "_out_TGuard", + "id": "xstate.pureaction._out_tguard" + } + ] + }, + { + "type": "doc", + "label": "raise", + "id": "xstate.raise" + }, + { + "type": "category", + "label": "RaiseAction", + "link": { + "type": "doc", + "id": "xstate.raiseaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TDelay", + "id": "xstate.raiseaction._out_tdelay" + }, + { + "type": "doc", + "label": "_out_TEvent", + "id": "xstate.raiseaction._out_tevent" + } + ] + }, + { + "type": "category", + "label": "RaiseActionOptions", + "link": { + "type": "doc", + "id": "xstate.raiseactionoptions" + }, + "items": [ + { + "type": "doc", + "label": "delay", + "id": "xstate.raiseactionoptions.delay" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.raiseactionoptions.id" + } + ] + }, + { + "type": "category", + "label": "RaiseActionParams", + "link": { + "type": "doc", + "id": "xstate.raiseactionparams" + }, + "items": [ + { + "type": "doc", + "label": "event", + "id": "xstate.raiseactionparams.event" + } + ] + }, + { + "type": "category", + "label": "ResolvedTypegenMeta", + "link": { + "type": "doc", + "id": "xstate.resolvedtypegenmeta" + }, + "items": [ + { + "type": "doc", + "label": "resolved", + "id": "xstate.resolvedtypegenmeta.resolved" + } + ] + }, + { + "type": "category", + "label": "ResolveTypegenMeta", + "link": { + "type": "doc", + "id": "xstate.resolvetypegenmeta" + }, + "items": [ + { + "type": "doc", + "label": "\"@@xstate/typegen\"", + "id": "xstate.resolvetypegenmeta.___xstate_typegen_" + }, + { + "type": "doc", + "label": "resolved", + "id": "xstate.resolvetypegenmeta.resolved" + } + ] + }, + { + "type": "doc", + "label": "SendExpr", + "id": "xstate.sendexpr" + }, + { + "type": "doc", + "label": "sendParent", + "id": "xstate.sendparent" + }, + { + "type": "doc", + "label": "sendTo", + "id": "xstate.sendto" + }, + { + "type": "category", + "label": "SendToAction", + "link": { + "type": "doc", + "id": "xstate.sendtoaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TDelay", + "id": "xstate.sendtoaction._out_tdelay" + } + ] + }, + { + "type": "doc", + "label": "SendToActionOptions", + "id": "xstate.sendtoactionoptions" + }, + { + "type": "category", + "label": "SendToActionParams", + "link": { + "type": "doc", + "id": "xstate.sendtoactionparams" + }, + "items": [ + { + "type": "doc", + "label": "event", + "id": "xstate.sendtoactionparams.event" + } + ] + }, + { + "type": "doc", + "label": "SimpleOrStateNodeConfig", + "id": "xstate.simpleorstatenodeconfig" + }, + { + "type": "category", + "label": "SimulatedClock", + "link": { + "type": "doc", + "id": "xstate.simulatedclock" + }, + "items": [ + { + "type": "doc", + "label": "clearTimeout", + "id": "xstate.simulatedclock.cleartimeout" + }, + { + "type": "doc", + "label": "now", + "id": "xstate.simulatedclock.now" + }, + { + "type": "doc", + "label": "setTimeout", + "id": "xstate.simulatedclock.settimeout" + } + ] + }, + { + "type": "category", + "label": "SimulatedClock", + "link": { + "type": "doc", + "id": "xstate.simulatedclock" + }, + "items": [ + { + "type": "doc", + "label": "increment", + "id": "xstate.simulatedclock.increment" + }, + { + "type": "doc", + "label": "set", + "id": "xstate.simulatedclock.set" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.simulatedclock.start" + } + ] + }, + { + "type": "doc", + "label": "SingleOrArray", + "id": "xstate.singleorarray" + }, + { + "type": "doc", + "label": "Snapshot", + "id": "xstate.snapshot" + }, + { + "type": "category", + "label": "SnapshotEvent", + "link": { + "type": "doc", + "id": "xstate.snapshotevent" + }, + "items": [ + { + "type": "doc", + "label": "snapshot", + "id": "xstate.snapshotevent.snapshot" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.snapshotevent.type" + } + ] + }, + { + "type": "doc", + "label": "SnapshotFrom", + "id": "xstate.snapshotfrom" + }, + { + "type": "doc", + "label": "Spawner", + "id": "xstate.spawner" + }, + { + "type": "doc", + "label": "SpecialTargets", + "id": "xstate.specialtargets" + }, + { + "type": "category", + "label": "State", + "link": { + "type": "doc", + "id": "xstate.state" + }, + "items": [ + { + "type": "doc", + "label": "(constructor)", + "id": "xstate.state._constructor_" + }, + { + "type": "doc", + "label": "can", + "id": "xstate.state.can" + }, + { + "type": "doc", + "label": "children", + "id": "xstate.state.children" + }, + { + "type": "doc", + "label": "configuration", + "id": "xstate.state.configuration" + }, + { + "type": "doc", + "label": "context", + "id": "xstate.state.context" + }, + { + "type": "doc", + "label": "error", + "id": "xstate.state.error" + }, + { + "type": "doc", + "label": "from", + "id": "xstate.state.from" + }, + { + "type": "doc", + "label": "hasTag", + "id": "xstate.state.hastag" + }, + { + "type": "doc", + "label": "historyValue", + "id": "xstate.state.historyvalue" + }, + { + "type": "doc", + "label": "machine", + "id": "xstate.state.machine" + }, + { + "type": "doc", + "label": "matches", + "id": "xstate.state.matches" + }, + { + "type": "doc", + "label": "meta", + "id": "xstate.state.meta" + }, + { + "type": "doc", + "label": "nextEvents", + "id": "xstate.state.nextevents" + }, + { + "type": "doc", + "label": "status", + "id": "xstate.state.status" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.state.tags" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.state.tojson" + }, + { + "type": "doc", + "label": "toStrings", + "id": "xstate.state.tostrings" + }, + { + "type": "doc", + "label": "value", + "id": "xstate.state.value" + } + ] + }, + { + "type": "category", + "label": "StateConfig", + "link": { + "type": "doc", + "id": "xstate.stateconfig" + }, + "items": [ + { + "type": "doc", + "label": "children", + "id": "xstate.stateconfig.children" + }, + { + "type": "doc", + "label": "configuration", + "id": "xstate.stateconfig.configuration" + }, + { + "type": "doc", + "label": "context", + "id": "xstate.stateconfig.context" + }, + { + "type": "doc", + "label": "error", + "id": "xstate.stateconfig.error" + }, + { + "type": "doc", + "label": "historyValue", + "id": "xstate.stateconfig.historyvalue" + }, + { + "type": "doc", + "label": "machine", + "id": "xstate.stateconfig.machine" + }, + { + "type": "doc", + "label": "meta", + "id": "xstate.stateconfig.meta" + }, + { + "type": "doc", + "label": "output", + "id": "xstate.stateconfig.output" + }, + { + "type": "doc", + "label": "status", + "id": "xstate.stateconfig.status" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.stateconfig.tags" + }, + { + "type": "doc", + "label": "value", + "id": "xstate.stateconfig.value" + } + ] + }, + { + "type": "doc", + "label": "StateFrom", + "id": "xstate.statefrom" + }, + { + "type": "doc", + "label": "stateIn", + "id": "xstate.statein" + }, + { + "type": "doc", + "label": "StateKey", + "id": "xstate.statekey" + }, + { + "type": "category", + "label": "StateLike", + "link": { + "type": "doc", + "id": "xstate.statelike" + }, + "items": [ + { + "type": "doc", + "label": "context", + "id": "xstate.statelike.context" + }, + { + "type": "doc", + "label": "event", + "id": "xstate.statelike.event" + }, + { + "type": "doc", + "label": "value", + "id": "xstate.statelike.value" + } + ] + }, + { + "type": "category", + "label": "StateMachine", + "link": { + "type": "doc", + "id": "xstate.statemachine" + }, + "items": [ + { + "type": "doc", + "label": "__TAction", + "id": "xstate.statemachine.__taction" + }, + { + "type": "doc", + "label": "__TActor", + "id": "xstate.statemachine.__tactor" + }, + { + "type": "doc", + "label": "__TContext", + "id": "xstate.statemachine.__tcontext" + }, + { + "type": "doc", + "label": "__TDelay", + "id": "xstate.statemachine.__tdelay" + }, + { + "type": "doc", + "label": "__TEvent", + "id": "xstate.statemachine.__tevent" + }, + { + "type": "doc", + "label": "__TGuard", + "id": "xstate.statemachine.__tguard" + }, + { + "type": "doc", + "label": "__TInput", + "id": "xstate.statemachine.__tinput" + }, + { + "type": "doc", + "label": "__TOutput", + "id": "xstate.statemachine.__toutput" + }, + { + "type": "doc", + "label": "__TResolvedTypesMeta", + "id": "xstate.statemachine.__tresolvedtypesmeta" + }, + { + "type": "doc", + "label": "__TTag", + "id": "xstate.statemachine.__ttag" + }, + { + "type": "doc", + "label": "__xstatenode", + "id": "xstate.statemachine.__xstatenode" + }, + { + "type": "doc", + "label": "(constructor)", + "id": "xstate.statemachine._constructor_" + }, + { + "type": "doc", + "label": "config", + "id": "xstate.statemachine.config" + }, + { + "type": "doc", + "label": "createState", + "id": "xstate.statemachine.createstate" + }, + { + "type": "doc", + "label": "definition", + "id": "xstate.statemachine.definition" + }, + { + "type": "doc", + "label": "events", + "id": "xstate.statemachine.events" + }, + { + "type": "doc", + "label": "getInitialState", + "id": "xstate.statemachine.getinitialstate" + }, + { + "type": "doc", + "label": "getPersistedState", + "id": "xstate.statemachine.getpersistedstate" + }, + { + "type": "doc", + "label": "getStateNodeById", + "id": "xstate.statemachine.getstatenodebyid" + }, + { + "type": "doc", + "label": "getTransitionData", + "id": "xstate.statemachine.gettransitiondata" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.statemachine.id" + }, + { + "type": "doc", + "label": "idMap", + "id": "xstate.statemachine.idmap" + }, + { + "type": "doc", + "label": "implementations", + "id": "xstate.statemachine.implementations" + }, + { + "type": "doc", + "label": "microstep", + "id": "xstate.statemachine.microstep" + }, + { + "type": "doc", + "label": "provide", + "id": "xstate.statemachine.provide" + }, + { + "type": "doc", + "label": "resolveState", + "id": "xstate.statemachine.resolvestate" + }, + { + "type": "doc", + "label": "resolveStateValue", + "id": "xstate.statemachine.resolvestatevalue" + }, + { + "type": "doc", + "label": "restoreState", + "id": "xstate.statemachine.restorestate" + }, + { + "type": "doc", + "label": "root", + "id": "xstate.statemachine.root" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.statemachine.start" + }, + { + "type": "doc", + "label": "states", + "id": "xstate.statemachine.states" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.statemachine.tojson" + }, + { + "type": "doc", + "label": "transition", + "id": "xstate.statemachine.transition" + }, + { + "type": "doc", + "label": "types", + "id": "xstate.statemachine.types" + }, + { + "type": "doc", + "label": "version", + "id": "xstate.statemachine.version" + } + ] + }, + { + "type": "doc", + "label": "StateMachineDefinition", + "id": "xstate.statemachinedefinition" + }, + { + "type": "category", + "label": "StateNode", + "link": { + "type": "doc", + "id": "xstate.statenode" + }, + "items": [ + { + "type": "doc", + "label": "_initialize", + "id": "xstate.statenode._initialize" + }, + { + "type": "doc", + "label": "(constructor)", + "id": "xstate.statenode._constructor_" + }, + { + "type": "doc", + "label": "after", + "id": "xstate.statenode.after" + }, + { + "type": "doc", + "label": "always", + "id": "xstate.statenode.always" + }, + { + "type": "doc", + "label": "config", + "id": "xstate.statenode.config" + }, + { + "type": "doc", + "label": "definition", + "id": "xstate.statenode.definition" + }, + { + "type": "doc", + "label": "description", + "id": "xstate.statenode.description" + }, + { + "type": "doc", + "label": "entry", + "id": "xstate.statenode.entry" + }, + { + "type": "doc", + "label": "events", + "id": "xstate.statenode.events" + }, + { + "type": "doc", + "label": "exit", + "id": "xstate.statenode.exit" + }, + { + "type": "doc", + "label": "history", + "id": "xstate.statenode.history" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.statenode.id" + }, + { + "type": "doc", + "label": "initial", + "id": "xstate.statenode.initial" + }, + { + "type": "doc", + "label": "invoke", + "id": "xstate.statenode.invoke" + }, + { + "type": "doc", + "label": "key", + "id": "xstate.statenode.key" + }, + { + "type": "doc", + "label": "machine", + "id": "xstate.statenode.machine" + }, + { + "type": "doc", + "label": "meta", + "id": "xstate.statenode.meta" + }, + { + "type": "doc", + "label": "next", + "id": "xstate.statenode.next" + }, + { + "type": "doc", + "label": "on", + "id": "xstate.statenode.on" + }, + { + "type": "doc", + "label": "order", + "id": "xstate.statenode.order" + }, + { + "type": "doc", + "label": "output", + "id": "xstate.statenode.output" + }, + { + "type": "doc", + "label": "ownEvents", + "id": "xstate.statenode.ownevents" + }, + { + "type": "doc", + "label": "parent", + "id": "xstate.statenode.parent" + }, + { + "type": "doc", + "label": "path", + "id": "xstate.statenode.path" + }, + { + "type": "doc", + "label": "states", + "id": "xstate.statenode.states" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.statenode.tags" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.statenode.tojson" + }, + { + "type": "doc", + "label": "transitions", + "id": "xstate.statenode.transitions" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.statenode.type" + } + ] + }, + { + "type": "category", + "label": "StateNodeConfig", + "link": { + "type": "doc", + "id": "xstate.statenodeconfig" + }, + "items": [ + { + "type": "doc", + "label": "after", + "id": "xstate.statenodeconfig.after" + }, + { + "type": "doc", + "label": "always", + "id": "xstate.statenodeconfig.always" + }, + { + "type": "doc", + "label": "description", + "id": "xstate.statenodeconfig.description" + }, + { + "type": "doc", + "label": "entry", + "id": "xstate.statenodeconfig.entry" + }, + { + "type": "doc", + "label": "exit", + "id": "xstate.statenodeconfig.exit" + }, + { + "type": "doc", + "label": "history", + "id": "xstate.statenodeconfig.history" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.statenodeconfig.id" + }, + { + "type": "doc", + "label": "initial", + "id": "xstate.statenodeconfig.initial" + }, + { + "type": "doc", + "label": "invoke", + "id": "xstate.statenodeconfig.invoke" + }, + { + "type": "doc", + "label": "meta", + "id": "xstate.statenodeconfig.meta" + }, + { + "type": "doc", + "label": "on", + "id": "xstate.statenodeconfig.on" + }, + { + "type": "doc", + "label": "onDone", + "id": "xstate.statenodeconfig.ondone" + }, + { + "type": "doc", + "label": "order", + "id": "xstate.statenodeconfig.order" + }, + { + "type": "doc", + "label": "output", + "id": "xstate.statenodeconfig.output" + }, + { + "type": "doc", + "label": "states", + "id": "xstate.statenodeconfig.states" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.statenodeconfig.tags" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.statenodeconfig.target" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.statenodeconfig.type" + } + ] + }, + { + "type": "category", + "label": "StateNodeDefinition", + "link": { + "type": "doc", + "id": "xstate.statenodedefinition" + }, + "items": [ + { + "type": "doc", + "label": "description", + "id": "xstate.statenodedefinition.description" + }, + { + "type": "doc", + "label": "entry", + "id": "xstate.statenodedefinition.entry" + }, + { + "type": "doc", + "label": "exit", + "id": "xstate.statenodedefinition.exit" + }, + { + "type": "doc", + "label": "history", + "id": "xstate.statenodedefinition.history" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.statenodedefinition.id" + }, + { + "type": "doc", + "label": "initial", + "id": "xstate.statenodedefinition.initial" + }, + { + "type": "doc", + "label": "invoke", + "id": "xstate.statenodedefinition.invoke" + }, + { + "type": "doc", + "label": "key", + "id": "xstate.statenodedefinition.key" + }, + { + "type": "doc", + "label": "meta", + "id": "xstate.statenodedefinition.meta" + }, + { + "type": "doc", + "label": "on", + "id": "xstate.statenodedefinition.on" + }, + { + "type": "doc", + "label": "order", + "id": "xstate.statenodedefinition.order" + }, + { + "type": "doc", + "label": "output", + "id": "xstate.statenodedefinition.output" + }, + { + "type": "doc", + "label": "states", + "id": "xstate.statenodedefinition.states" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.statenodedefinition.tags" + }, + { + "type": "doc", + "label": "transitions", + "id": "xstate.statenodedefinition.transitions" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.statenodedefinition.type" + }, + { + "type": "doc", + "label": "version", + "id": "xstate.statenodedefinition.version" + } + ] + }, + { + "type": "doc", + "label": "StateNodesConfig", + "id": "xstate.statenodesconfig" + }, + { + "type": "doc", + "label": "StatesConfig", + "id": "xstate.statesconfig" + }, + { + "type": "doc", + "label": "StatesDefinition", + "id": "xstate.statesdefinition" + }, + { + "type": "doc", + "label": "StateTypes", + "id": "xstate.statetypes" + }, + { + "type": "doc", + "label": "StateValue", + "id": "xstate.statevalue" + }, + { + "type": "doc", + "label": "StateValueFrom", + "id": "xstate.statevaluefrom" + }, + { + "type": "doc", + "label": "StateValueMap", + "id": "xstate.statevaluemap" + }, + { + "type": "doc", + "label": "stop_2", + "id": "xstate.stop_2" + }, + { + "type": "doc", + "label": "StopAction", + "id": "xstate.stopaction" + }, + { + "type": "category", + "label": "Subscribable", + "link": { + "type": "doc", + "id": "xstate.subscribable" + }, + "items": [ + { + "type": "doc", + "label": "subscribe", + "id": "xstate.subscribable.subscribe" + }, + { + "type": "doc", + "label": "subscribe", + "id": "xstate.subscribable.subscribe_1" + } + ] + }, + { + "type": "category", + "label": "Subscription", + "link": { + "type": "doc", + "id": "xstate.subscription" + }, + "items": [ + { + "type": "doc", + "label": "unsubscribe", + "id": "xstate.subscription.unsubscribe" + } + ] + }, + { + "type": "doc", + "label": "TagsFrom", + "id": "xstate.tagsfrom" + }, + { + "type": "doc", + "label": "TODO", + "id": "xstate.todo" + }, + { + "type": "doc", + "label": "toObserver", + "id": "xstate.toobserver" + }, + { + "type": "doc", + "label": "TransitionActorLogic", + "id": "xstate.transitionactorlogic" + }, + { + "type": "category", + "label": "TransitionConfig", + "link": { + "type": "doc", + "id": "xstate.transitionconfig" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.transitionconfig.actions" + }, + { + "type": "doc", + "label": "description", + "id": "xstate.transitionconfig.description" + }, + { + "type": "doc", + "label": "guard", + "id": "xstate.transitionconfig.guard" + }, + { + "type": "doc", + "label": "meta", + "id": "xstate.transitionconfig.meta" + }, + { + "type": "doc", + "label": "reenter", + "id": "xstate.transitionconfig.reenter" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.transitionconfig.target" + } + ] + }, + { + "type": "doc", + "label": "TransitionConfigOrTarget", + "id": "xstate.transitionconfigortarget" + }, + { + "type": "doc", + "label": "TransitionConfigTarget", + "id": "xstate.transitionconfigtarget" + }, + { + "type": "category", + "label": "TransitionDefinition", + "link": { + "type": "doc", + "id": "xstate.transitiondefinition" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.transitiondefinition.actions" + }, + { + "type": "doc", + "label": "eventType", + "id": "xstate.transitiondefinition.eventtype" + }, + { + "type": "doc", + "label": "guard", + "id": "xstate.transitiondefinition.guard" + }, + { + "type": "doc", + "label": "reenter", + "id": "xstate.transitiondefinition.reenter" + }, + { + "type": "doc", + "label": "source", + "id": "xstate.transitiondefinition.source" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.transitiondefinition.target" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.transitiondefinition.tojson" + } + ] + }, + { + "type": "doc", + "label": "TransitionDefinitionMap", + "id": "xstate.transitiondefinitionmap" + }, + { + "type": "doc", + "label": "Transitions", + "id": "xstate.transitions" + }, + { + "type": "doc", + "label": "TransitionsConfig", + "id": "xstate.transitionsconfig" + }, + { + "type": "doc", + "label": "TransitionSnapshot", + "id": "xstate.transitionsnapshot" + }, + { + "type": "doc", + "label": "TransitionTarget", + "id": "xstate.transitiontarget" + }, + { + "type": "doc", + "label": "TypegenConstraint", + "id": "xstate.typegenconstraint" + }, + { + "type": "category", + "label": "TypegenDisabled", + "link": { + "type": "doc", + "id": "xstate.typegendisabled" + }, + "items": [ + { + "type": "doc", + "label": "\"@@xstate/typegen\"", + "id": "xstate.typegendisabled.___xstate_typegen_" + } + ] + }, + { + "type": "category", + "label": "TypegenEnabled", + "link": { + "type": "doc", + "id": "xstate.typegenenabled" + }, + "items": [ + { + "type": "doc", + "label": "\"@@xstate/typegen\"", + "id": "xstate.typegenenabled.___xstate_typegen_" + } + ] + }, + { + "type": "category", + "label": "TypegenMeta", + "link": { + "type": "doc", + "id": "xstate.typegenmeta" + }, + "items": [ + { + "type": "doc", + "label": "eventsCausingActions", + "id": "xstate.typegenmeta.eventscausingactions" + }, + { + "type": "doc", + "label": "eventsCausingActors", + "id": "xstate.typegenmeta.eventscausingactors" + }, + { + "type": "doc", + "label": "eventsCausingDelays", + "id": "xstate.typegenmeta.eventscausingdelays" + }, + { + "type": "doc", + "label": "eventsCausingGuards", + "id": "xstate.typegenmeta.eventscausingguards" + }, + { + "type": "doc", + "label": "internalEvents", + "id": "xstate.typegenmeta.internalevents" + }, + { + "type": "doc", + "label": "invokeSrcNameMap", + "id": "xstate.typegenmeta.invokesrcnamemap" + }, + { + "type": "doc", + "label": "matchesStates", + "id": "xstate.typegenmeta.matchesstates" + }, + { + "type": "doc", + "label": "missingImplementations", + "id": "xstate.typegenmeta.missingimplementations" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.typegenmeta.tags" + } + ] + }, + { + "type": "category", + "label": "UnifiedArg", + "link": { + "type": "doc", + "id": "xstate.unifiedarg" + }, + "items": [ + { + "type": "doc", + "label": "context", + "id": "xstate.unifiedarg.context" + }, + { + "type": "doc", + "label": "event", + "id": "xstate.unifiedarg.event" + }, + { + "type": "doc", + "label": "self", + "id": "xstate.unifiedarg.self" + }, + { + "type": "doc", + "label": "system", + "id": "xstate.unifiedarg.system" + } + ] + }, + { + "type": "doc", + "label": "UnknownAction", + "id": "xstate.unknownaction" + }, + { + "type": "doc", + "label": "Values", + "id": "xstate.values" + }, + { + "type": "doc", + "label": "waitFor", + "id": "xstate.waitfor" + }, + { + "type": "doc", + "label": "WithDynamicParams", + "id": "xstate.withdynamicparams" + } + ] + } +] \ No newline at end of file diff --git a/tools/xstate-api-documenter-docusaurus-plugin/.gitignore b/tools/xstate-api-documenter-docusaurus-plugin/.gitignore new file mode 100644 index 000000000..b94707787 --- /dev/null +++ b/tools/xstate-api-documenter-docusaurus-plugin/.gitignore @@ -0,0 +1,2 @@ +node_modules/ +dist/ diff --git a/tools/xstate-api-documenter-docusaurus-plugin/package.json b/tools/xstate-api-documenter-docusaurus-plugin/package.json new file mode 100644 index 000000000..39c00ad4a --- /dev/null +++ b/tools/xstate-api-documenter-docusaurus-plugin/package.json @@ -0,0 +1,15 @@ +{ + "name": "xstate-api-documenter-docusaurus-plugin", + "version": "1.0.0", + "main": "dist/index.js", + "private": true, + "dependencies": { + "@microsoft/api-extractor-model": "7.28.2" + }, + "devDependencies": { + "typescript": "5.2.2" + }, + "engines": { + "node": ">=16.14" + } +} diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.ts b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.ts new file mode 100644 index 000000000..4ff01be3d --- /dev/null +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.ts @@ -0,0 +1,129 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. +// See LICENSE in the project root for license information. + +import * as fs from 'node:fs' +import * as path from 'node:path'; +import { ApiItem } from '@microsoft/api-extractor-model'; +import { + MarkdownDocumenterFeature, + IMarkdownDocumenterFeatureOnBeforeWritePageArgs, + IMarkdownDocumenterFeatureOnFinishedArgs +} from '@microsoft/api-documenter'; + +interface INavigationNode { + type: string; + label: string; + id?: string; + items?: INavigationNode[]; + link?: object +} + +interface INavigationFile extends INavigationNode {} + +export class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { + private _apiItemsWithPages: Set = new Set(); + + public onInitialized(): void { + console.log('RushStackFeature: onInitialized()'); + } + + public onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void { + // Add the Docusaurus frontmatter + const header: string = [ + `---`, + // Generated API docs have a built-in title header below the breadcrumbs + // `title: ${JSON.stringify(eventArgs.apiItem.displayName)}`, + `hide_title: true`, + // Suppress the default Edit button and Next/Prev links for API docs + `custom_edit_url: null`, + `pagination_prev: null`, + `pagination_next: null`, + `---`, + '' + ].join('\n'); + eventArgs.pageContent = header + eventArgs.pageContent; + + // API Documenter generates "" comments to prevent emitted Markdown from + // being misinterpreted in certain contexts that are handed ambiguously by different + // Markdown engines. See these test cases for some examples: + // + // https://github.com/microsoft/rushstack/blob/484a7be546784783f5a7b4d387cbb48b0cebde27/apps/api-documenter/src/markdown/test/__snapshots__/CustomMarkdownEmitter.test.ts.snap#L25 + // https://github.com/microsoft/rushstack/blob/484a7be546784783f5a7b4d387cbb48b0cebde27/apps/api-documenter/src/markdown/MarkdownEmitter.ts#L248 + // + // HTML comments don't work with Docusaurus, because it uses MDX instead of Markdown. + // However empty React fragments have an equivalent effect: + eventArgs.pageContent = eventArgs.pageContent.replace(//g, '<>'); + + // try to remove breadcrumbs + // by removing any lines that start with [Home] + eventArgs.pageContent = eventArgs.pageContent.replace(/\[Home\]\(.\/index.md\) >.+/, '') + + this._apiItemsWithPages.add(eventArgs.apiItem); + } + + public onFinished(eventArgs: IMarkdownDocumenterFeatureOnFinishedArgs): void { + console.log('finished!!!!') + // const navigationFile: INavigationFile = { + // type: 'category', + // label: 'API Reference', + // items: [ + // { + // type: 'doc', + // label: '(members)', + // id: 'index' + // } + // ] + // }; + // this._buildNavigation(navigationFile.items!, this.context.apiModel); + + let navigationFile:[] = [] + this._buildNavigation(navigationFile, this.context.apiModel); + + const navFilePath: string = path.join(this.context.outputFolder, '..', '..', 'sidebar-xstate-api.json'); + const navFileContent: string = JSON.stringify(navigationFile, undefined, 2); + + console.log('writing:', navFilePath) + fs.writeFileSync(navFilePath, navFileContent); + } + + private _buildNavigation(parentNodes: INavigationNode[], parentApiItem: ApiItem): void { + for (const apiItem of parentApiItem.members) { + if (this._apiItemsWithPages.has(apiItem)) { + const label = apiItem.displayName; + + const id = path.posix + .join(this.context.documenter.getLinkForApiItem(apiItem)!) + .replace(/\.md$/, '') + .replace(/\/$/, '/index'); + const children: INavigationNode[] = []; + this._buildNavigation(children, apiItem); + + if (children.length > 0) { + const newNode: INavigationNode = { + type: 'category', + label, + link: { type: 'doc', id }, + items: [ + // { + // type: 'doc', + // label: '(members)', + // id + // }, + ...children + ] + }; + parentNodes.push(newNode); + } else { + const newNode: INavigationNode = { + type: 'doc', + label, + id + }; + parentNodes.push(newNode); + } + } else { + this._buildNavigation(parentNodes, apiItem); + } + } + } +} diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/index.ts b/tools/xstate-api-documenter-docusaurus-plugin/src/index.ts new file mode 100644 index 000000000..59aa8ed55 --- /dev/null +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/index.ts @@ -0,0 +1,16 @@ +// Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. +// See LICENSE in the project root for license information. + +import { IApiDocumenterPluginManifest } from '@microsoft/api-documenter'; +import { DocusaurusMarkdownFeature } from './DocusaurusMarkdownFeature'; + +export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = { + manifestVersion: 1000, + features: [ + { + featureName: 'docusaurus-markdown-documenter', + kind: 'MarkdownDocumenterFeature', + subclass: DocusaurusMarkdownFeature + } + ] +}; diff --git a/tools/xstate-api-documenter-docusaurus-plugin/tsconfig.json b/tools/xstate-api-documenter-docusaurus-plugin/tsconfig.json new file mode 100644 index 000000000..81deedd74 --- /dev/null +++ b/tools/xstate-api-documenter-docusaurus-plugin/tsconfig.json @@ -0,0 +1,28 @@ +{ + "$schema": "http://json.schemastore.org/tsconfig", + + "compilerOptions": { + "outDir": "dist", + "rootDir": "src", + + "forceConsistentCasingInFileNames": true, + "jsx": "react", + "declaration": true, + "sourceMap": true, + "declarationMap": true, + "inlineSources": true, + "experimentalDecorators": true, + "strict": true, + "useUnknownInCatchVariables": false, + "esModuleInterop": true, + "noEmitOnError": false, + "allowUnreachableCode": false, + + "types": [], + + "module": "commonjs", + "target": "es2017", + "lib": ["es2017"] + }, + "include": ["src/**/*.ts"] +} diff --git a/tools/xstate-api-documenter-docusaurus-plugin/yarn.lock b/tools/xstate-api-documenter-docusaurus-plugin/yarn.lock new file mode 100644 index 000000000..4ec8f6fd3 --- /dev/null +++ b/tools/xstate-api-documenter-docusaurus-plugin/yarn.lock @@ -0,0 +1,212 @@ +# THIS IS AN AUTOGENERATED FILE. DO NOT EDIT THIS FILE DIRECTLY. +# yarn lockfile v1 + + +"@microsoft/api-extractor-model@7.28.2": + version "7.28.2" + resolved "https://registry.yarnpkg.com/@microsoft/api-extractor-model/-/api-extractor-model-7.28.2.tgz#91c66dd820ccc70e0c163e06b392d8363f1b9269" + integrity sha512-vkojrM2fo3q4n4oPh4uUZdjJ2DxQ2+RnDQL/xhTWSRUNPF6P4QyrvY357HBxbnltKcYu+nNNolVqc6TIGQ73Ig== + dependencies: + "@microsoft/tsdoc" "0.14.2" + "@microsoft/tsdoc-config" "~0.16.1" + "@rushstack/node-core-library" "3.61.0" + +"@microsoft/tsdoc-config@~0.16.1": + version "0.16.2" + resolved "https://registry.yarnpkg.com/@microsoft/tsdoc-config/-/tsdoc-config-0.16.2.tgz#b786bb4ead00d54f53839a458ce626c8548d3adf" + integrity sha512-OGiIzzoBLgWWR0UdRJX98oYO+XKGf7tiK4Zk6tQ/E4IJqGCe7dvkTvgDZV5cFJUzLGDOjeAXrnZoA6QkVySuxw== + dependencies: + "@microsoft/tsdoc" "0.14.2" + ajv "~6.12.6" + jju "~1.4.0" + resolve "~1.19.0" + +"@microsoft/tsdoc@0.14.2": + version "0.14.2" + resolved "https://registry.yarnpkg.com/@microsoft/tsdoc/-/tsdoc-0.14.2.tgz#c3ec604a0b54b9a9b87e9735dfc59e1a5da6a5fb" + integrity sha512-9b8mPpKrfeGRuhFH5iO1iwCLeIIsV6+H1sRfxbkoGXIyQE2BTsPd9zqSqQJ+pv5sJ/hT5M1zvOFL02MnEezFug== + +"@rushstack/node-core-library@3.61.0": + version "3.61.0" + resolved "https://registry.yarnpkg.com/@rushstack/node-core-library/-/node-core-library-3.61.0.tgz#7441a0d2ae5268b758a7a49588a78cd55af57e66" + integrity sha512-tdOjdErme+/YOu4gPed3sFS72GhtWCgNV9oDsHDnoLY5oDfwjKUc9Z+JOZZ37uAxcm/OCahDHfuu2ugqrfWAVQ== + dependencies: + colors "~1.2.1" + fs-extra "~7.0.1" + import-lazy "~4.0.0" + jju "~1.4.0" + resolve "~1.22.1" + semver "~7.5.4" + z-schema "~5.0.2" + +ajv@~6.12.6: + version "6.12.6" + resolved "https://registry.yarnpkg.com/ajv/-/ajv-6.12.6.tgz#baf5a62e802b07d977034586f8c3baf5adf26df4" + integrity sha512-j3fVLgvTo527anyYyJOGTYJbG+vnnQYvE0m5mmkc1TK+nxAppkCLMIL0aZ4dblVCNoGShhm+kzE4ZUykBoMg4g== + dependencies: + fast-deep-equal "^3.1.1" + fast-json-stable-stringify "^2.0.0" + json-schema-traverse "^0.4.1" + uri-js "^4.2.2" + +colors@~1.2.1: + version "1.2.5" + resolved "https://registry.yarnpkg.com/colors/-/colors-1.2.5.tgz#89c7ad9a374bc030df8013241f68136ed8835afc" + integrity sha512-erNRLao/Y3Fv54qUa0LBB+//Uf3YwMUmdJinN20yMXm9zdKKqH9wt7R9IIVZ+K7ShzfpLV/Zg8+VyrBJYB4lpg== + +commander@^10.0.0: + version "10.0.1" + resolved "https://registry.yarnpkg.com/commander/-/commander-10.0.1.tgz#881ee46b4f77d1c1dccc5823433aa39b022cbe06" + integrity sha512-y4Mg2tXshplEbSGzx7amzPwKKOCGuoSRP/CjEdwwk0FOGlUbq6lKuoyDZTNZkmxHdJtp54hdfY/JUrdL7Xfdug== + +fast-deep-equal@^3.1.1: + version "3.1.3" + resolved "https://registry.yarnpkg.com/fast-deep-equal/-/fast-deep-equal-3.1.3.tgz#3a7d56b559d6cbc3eb512325244e619a65c6c525" + integrity sha512-f3qQ9oQy9j2AhBe/H9VC91wLmKBCCU/gDOnKNAYG5hswO7BLKj09Hc5HYNz9cGI++xlpDCIgDaitVs03ATR84Q== + +fast-json-stable-stringify@^2.0.0: + version "2.1.0" + resolved "https://registry.yarnpkg.com/fast-json-stable-stringify/-/fast-json-stable-stringify-2.1.0.tgz#874bf69c6f404c2b5d99c481341399fd55892633" + integrity sha512-lhd/wF+Lk98HZoTCtlVraHtfh5XYijIjalXck7saUtuanSDyLMxnHhSXEDJqHxD7msR8D0uCmqlkwjCV8xvwHw== + +fs-extra@~7.0.1: + version "7.0.1" + resolved "https://registry.yarnpkg.com/fs-extra/-/fs-extra-7.0.1.tgz#4f189c44aa123b895f722804f55ea23eadc348e9" + integrity sha512-YJDaCJZEnBmcbw13fvdAM9AwNOJwOzrE4pqMqBq5nFiEqXUqHwlK4B+3pUw6JNvfSPtX05xFHtYy/1ni01eGCw== + dependencies: + graceful-fs "^4.1.2" + jsonfile "^4.0.0" + universalify "^0.1.0" + +graceful-fs@^4.1.2, graceful-fs@^4.1.6: + version "4.2.11" + resolved "https://registry.yarnpkg.com/graceful-fs/-/graceful-fs-4.2.11.tgz#4183e4e8bf08bb6e05bbb2f7d2e0c8f712ca40e3" + integrity sha512-RbJ5/jmFcNNCcDV5o9eTnBLJ/HszWV0P73bc+Ff4nS/rJj+YaS6IGyiOL0VoBYX+l1Wrl3k63h/KrH+nhJ0XvQ== + +has@^1.0.3: + version "1.0.4" + resolved "https://registry.yarnpkg.com/has/-/has-1.0.4.tgz#2eb2860e000011dae4f1406a86fe80e530fb2ec6" + integrity sha512-qdSAmqLF6209RFj4VVItywPMbm3vWylknmB3nvNiUIs72xAimcM8nVYxYr7ncvZq5qzk9MKIZR8ijqD/1QuYjQ== + +import-lazy@~4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/import-lazy/-/import-lazy-4.0.0.tgz#e8eb627483a0a43da3c03f3e35548be5cb0cc153" + integrity sha512-rKtvo6a868b5Hu3heneU+L4yEQ4jYKLtjpnPeUdK7h0yzXGmyBTypknlkCvHFBqfX9YlorEiMM6Dnq/5atfHkw== + +is-core-module@^2.1.0, is-core-module@^2.13.0: + version "2.13.0" + resolved "https://registry.yarnpkg.com/is-core-module/-/is-core-module-2.13.0.tgz#bb52aa6e2cbd49a30c2ba68c42bf3435ba6072db" + integrity sha512-Z7dk6Qo8pOCp3l4tsX2C5ZVas4V+UxwQodwZhLopL91TX8UyyHEXafPcyoeeWuLrwzHcr3igO78wNLwHJHsMCQ== + dependencies: + has "^1.0.3" + +jju@~1.4.0: + version "1.4.0" + resolved "https://registry.yarnpkg.com/jju/-/jju-1.4.0.tgz#a3abe2718af241a2b2904f84a625970f389ae32a" + integrity sha512-8wb9Yw966OSxApiCt0K3yNJL8pnNeIv+OEq2YMidz4FKP6nonSRoOXc80iXY4JaN2FC11B9qsNmDsm+ZOfMROA== + +json-schema-traverse@^0.4.1: + version "0.4.1" + resolved "https://registry.yarnpkg.com/json-schema-traverse/-/json-schema-traverse-0.4.1.tgz#69f6a87d9513ab8bb8fe63bdb0979c448e684660" + integrity sha512-xbbCH5dCYU5T8LcEhhuh7HJ88HXuW3qsI3Y0zOZFKfZEHcpWiHU/Jxzk629Brsab/mMiHQti9wMP+845RPe3Vg== + +jsonfile@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/jsonfile/-/jsonfile-4.0.0.tgz#8771aae0799b64076b76640fca058f9c10e33ecb" + integrity sha512-m6F1R3z8jjlf2imQHS2Qez5sjKWQzbuuhuJ/FKYFRZvPE3PuHcSMVZzfsLhGVOkfd20obL5SWEBew5ShlquNxg== + optionalDependencies: + graceful-fs "^4.1.6" + +lodash.get@^4.4.2: + version "4.4.2" + resolved "https://registry.yarnpkg.com/lodash.get/-/lodash.get-4.4.2.tgz#2d177f652fa31e939b4438d5341499dfa3825e99" + integrity sha512-z+Uw/vLuy6gQe8cfaFWD7p0wVv8fJl3mbzXh33RS+0oW2wvUqiRXiQ69gLWSLpgB5/6sU+r6BlQR0MBILadqTQ== + +lodash.isequal@^4.5.0: + version "4.5.0" + resolved "https://registry.yarnpkg.com/lodash.isequal/-/lodash.isequal-4.5.0.tgz#415c4478f2bcc30120c22ce10ed3226f7d3e18e0" + integrity sha512-pDo3lu8Jhfjqls6GkMgpahsF9kCyayhgykjyLMNFTKWrpVdAQtYyB4muAMWozBB4ig/dtWAmsMxLEI8wuz+DYQ== + +lru-cache@^6.0.0: + version "6.0.0" + resolved "https://registry.yarnpkg.com/lru-cache/-/lru-cache-6.0.0.tgz#6d6fe6570ebd96aaf90fcad1dafa3b2566db3a94" + integrity sha512-Jo6dJ04CmSjuznwJSS3pUeWmd/H0ffTlkXXgwZi+eq1UCmqQwCh+eLsYOYCwY991i2Fah4h1BEMCx4qThGbsiA== + dependencies: + yallist "^4.0.0" + +path-parse@^1.0.6, path-parse@^1.0.7: + version "1.0.7" + resolved "https://registry.yarnpkg.com/path-parse/-/path-parse-1.0.7.tgz#fbc114b60ca42b30d9daf5858e4bd68bbedb6735" + integrity sha512-LDJzPVEEEPR+y48z93A0Ed0yXb8pAByGWo/k5YYdYgpY2/2EsOsksJrq7lOHxryrVOn1ejG6oAp8ahvOIQD8sw== + +punycode@^2.1.0: + version "2.3.0" + resolved "https://registry.yarnpkg.com/punycode/-/punycode-2.3.0.tgz#f67fa67c94da8f4d0cfff981aee4118064199b8f" + integrity sha512-rRV+zQD8tVFys26lAGR9WUuS4iUAngJScM+ZRSKtvl5tKeZ2t5bvdNFdNHBW9FWR4guGHlgmsZ1G7BSm2wTbuA== + +resolve@~1.19.0: + version "1.19.0" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.19.0.tgz#1af5bf630409734a067cae29318aac7fa29a267c" + integrity sha512-rArEXAgsBG4UgRGcynxWIWKFvh/XZCcS8UJdHhwy91zwAvCZIbcs+vAbflgBnNjYMs/i/i+/Ux6IZhML1yPvxg== + dependencies: + is-core-module "^2.1.0" + path-parse "^1.0.6" + +resolve@~1.22.1: + version "1.22.8" + resolved "https://registry.yarnpkg.com/resolve/-/resolve-1.22.8.tgz#b6c87a9f2aa06dfab52e3d70ac8cde321fa5a48d" + integrity sha512-oKWePCxqpd6FlLvGV1VU0x7bkPmmCNolxzjMf4NczoDnQcIWrAF+cPtZn5i6n+RfD2d9i0tzpKnG6Yk168yIyw== + dependencies: + is-core-module "^2.13.0" + path-parse "^1.0.7" + supports-preserve-symlinks-flag "^1.0.0" + +semver@~7.5.4: + version "7.5.4" + resolved "https://registry.yarnpkg.com/semver/-/semver-7.5.4.tgz#483986ec4ed38e1c6c48c34894a9182dbff68a6e" + integrity sha512-1bCSESV6Pv+i21Hvpxp3Dx+pSD8lIPt8uVjRrxAUt/nbswYc+tK6Y2btiULjd4+fnq15PX+nqQDC7Oft7WkwcA== + dependencies: + lru-cache "^6.0.0" + +supports-preserve-symlinks-flag@^1.0.0: + version "1.0.0" + resolved "https://registry.yarnpkg.com/supports-preserve-symlinks-flag/-/supports-preserve-symlinks-flag-1.0.0.tgz#6eda4bd344a3c94aea376d4cc31bc77311039e09" + integrity sha512-ot0WnXS9fgdkgIcePe6RHNk1WA8+muPa6cSjeR3V8K27q9BB1rTE3R1p7Hv0z1ZyAc8s6Vvv8DIyWf681MAt0w== + +typescript@5.2.2: + version "5.2.2" + resolved "https://registry.yarnpkg.com/typescript/-/typescript-5.2.2.tgz#5ebb5e5a5b75f085f22bc3f8460fba308310fa78" + integrity sha512-mI4WrpHsbCIcwT9cF4FZvr80QUeKvsUsUvKDoR+X/7XHQH98xYD8YHZg7ANtz2GtZt/CBq2QJ0thkGJMHfqc1w== + +universalify@^0.1.0: + version "0.1.2" + resolved "https://registry.yarnpkg.com/universalify/-/universalify-0.1.2.tgz#b646f69be3942dabcecc9d6639c80dc105efaa66" + integrity sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg== + +uri-js@^4.2.2: + version "4.4.1" + resolved "https://registry.yarnpkg.com/uri-js/-/uri-js-4.4.1.tgz#9b1a52595225859e55f669d928f88c6c57f2a77e" + integrity sha512-7rKUyy33Q1yc98pQ1DAmLtwX109F7TIfWlW1Ydo8Wl1ii1SeHieeh0HHfPeL2fMXK6z0s8ecKs9frCuLJvndBg== + dependencies: + punycode "^2.1.0" + +validator@^13.7.0: + version "13.11.0" + resolved "https://registry.yarnpkg.com/validator/-/validator-13.11.0.tgz#23ab3fd59290c61248364eabf4067f04955fbb1b" + integrity sha512-Ii+sehpSfZy+At5nPdnyMhx78fEoPDkR2XW/zimHEL3MyGJQOCQ7WeP20jPYRz7ZCpcKLB21NxuXHF3bxjStBQ== + +yallist@^4.0.0: + version "4.0.0" + resolved "https://registry.yarnpkg.com/yallist/-/yallist-4.0.0.tgz#9bb92790d9c0effec63be73519e11a35019a3a72" + integrity sha512-3wdGidZyq5PB084XLES5TpOSRA3wjXAlIWMhum2kRcv/41Sn2emQ0dycQW4uZXLejwKvg6EsvbdlVL+FYEct7A== + +z-schema@~5.0.2: + version "5.0.6" + resolved "https://registry.yarnpkg.com/z-schema/-/z-schema-5.0.6.tgz#46d6a687b15e4a4369e18d6cb1c7b8618fc256c5" + integrity sha512-+XR1GhnWklYdfr8YaZv/iu+vY+ux7V5DS5zH1DQf6bO5ufrt/5cgNhVO5qyhsjFXvsqQb/f08DWE9b6uPscyAg== + dependencies: + lodash.get "^4.4.2" + lodash.isequal "^4.5.0" + validator "^13.7.0" + optionalDependencies: + commander "^10.0.0" From d5decb492ed54cf0de31e9c736fcd26399f4f886 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 21:37:14 -0500 Subject: [PATCH 29/43] convert plugin from ts to js --- .../package.json | 5 +- ...eature.ts => DocusaurusMarkdownFeature.js} | 101 +++++++++++------- .../src/{index.ts => index.js} | 9 +- 3 files changed, 68 insertions(+), 47 deletions(-) rename tools/xstate-api-documenter-docusaurus-plugin/src/{DocusaurusMarkdownFeature.ts => DocusaurusMarkdownFeature.js} (66%) rename tools/xstate-api-documenter-docusaurus-plugin/src/{index.ts => index.js} (55%) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/package.json b/tools/xstate-api-documenter-docusaurus-plugin/package.json index 39c00ad4a..517327cb8 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/package.json +++ b/tools/xstate-api-documenter-docusaurus-plugin/package.json @@ -1,14 +1,11 @@ { "name": "xstate-api-documenter-docusaurus-plugin", "version": "1.0.0", - "main": "dist/index.js", + "main": "src/index.js", "private": true, "dependencies": { "@microsoft/api-extractor-model": "7.28.2" }, - "devDependencies": { - "typescript": "5.2.2" - }, "engines": { "node": ">=16.14" } diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.ts b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js similarity index 66% rename from tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.ts rename to tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index 4ff01be3d..1ff3354ff 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.ts +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -1,35 +1,44 @@ +// See: https://api.rushstack.io/pages/api-documenter + // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import * as fs from 'node:fs' -import * as path from 'node:path'; -import { ApiItem } from '@microsoft/api-extractor-model'; -import { - MarkdownDocumenterFeature, - IMarkdownDocumenterFeatureOnBeforeWritePageArgs, - IMarkdownDocumenterFeatureOnFinishedArgs -} from '@microsoft/api-documenter'; - -interface INavigationNode { - type: string; - label: string; - id?: string; - items?: INavigationNode[]; - link?: object -} - -interface INavigationFile extends INavigationNode {} - -export class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { - private _apiItemsWithPages: Set = new Set(); - - public onInitialized(): void { - console.log('RushStackFeature: onInitialized()'); - } - - public onBeforeWritePage(eventArgs: IMarkdownDocumenterFeatureOnBeforeWritePageArgs): void { +const fs = require('node:fs'); +const path = require('node:path'); +const { MarkdownDocumenterFeature } = require('@microsoft/api-documenter'); + +/** + * @typedef {Object} INavigationNode + * @property {string} type + * @property {string} label + * @property {string} [id] + * @property {INavigationNode[]} [items] + * @property {object} [link] + */ + +/** @typedef {Object} INavigationFile */ + +class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { + /** + * @private + * @default new Set() + */ + _apiItemsWithPages = new Set(); + + /** + * @public + * @returns {void} + */ + onInitialized() {} + + /** + * @public + * @param {IMarkdownDocumenterFeatureOnBeforeWritePageArgs} eventArgs + * @returns {void} + */ + onBeforeWritePage(eventArgs) { // Add the Docusaurus frontmatter - const header: string = [ + const header = [ `---`, // Generated API docs have a built-in title header below the breadcrumbs // `title: ${JSON.stringify(eventArgs.apiItem.displayName)}`, @@ -56,13 +65,17 @@ export class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { // try to remove breadcrumbs // by removing any lines that start with [Home] - eventArgs.pageContent = eventArgs.pageContent.replace(/\[Home\]\(.\/index.md\) >.+/, '') + eventArgs.pageContent = eventArgs.pageContent.replace(/\[Home\]\(.\/index.md\) >.+/, ''); this._apiItemsWithPages.add(eventArgs.apiItem); } - public onFinished(eventArgs: IMarkdownDocumenterFeatureOnFinishedArgs): void { - console.log('finished!!!!') + /** + * @public + * @param {IMarkdownDocumenterFeatureOnFinishedArgs} eventArgs + * @returns {void} + */ + onFinished(eventArgs) { // const navigationFile: INavigationFile = { // type: 'category', // label: 'API Reference', @@ -76,30 +89,36 @@ export class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { // }; // this._buildNavigation(navigationFile.items!, this.context.apiModel); - let navigationFile:[] = [] + let navigationFile = [] this._buildNavigation(navigationFile, this.context.apiModel); - const navFilePath: string = path.join(this.context.outputFolder, '..', '..', 'sidebar-xstate-api.json'); - const navFileContent: string = JSON.stringify(navigationFile, undefined, 2); + const navFilePath = path.join(this.context.outputFolder, '..', '..', 'sidebar-xstate-api.json'); + const navFileContent = JSON.stringify(navigationFile, undefined, 2); - console.log('writing:', navFilePath) + console.log('writing:', navFilePath); fs.writeFileSync(navFilePath, navFileContent); } - private _buildNavigation(parentNodes: INavigationNode[], parentApiItem: ApiItem): void { + /** + * @private + * @param {INavigationNode[]} parentNodes + * @param {ApiItem} parentApiItem + * @returns {void} + */ + _buildNavigation(parentNodes, parentApiItem) { for (const apiItem of parentApiItem.members) { if (this._apiItemsWithPages.has(apiItem)) { const label = apiItem.displayName; const id = path.posix - .join(this.context.documenter.getLinkForApiItem(apiItem)!) + .join(this.context.documenter.getLinkForApiItem(apiItem)) .replace(/\.md$/, '') .replace(/\/$/, '/index'); - const children: INavigationNode[] = []; + const children = []; this._buildNavigation(children, apiItem); if (children.length > 0) { - const newNode: INavigationNode = { + const newNode = { type: 'category', label, link: { type: 'doc', id }, @@ -114,7 +133,7 @@ export class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { }; parentNodes.push(newNode); } else { - const newNode: INavigationNode = { + const newNode = { type: 'doc', label, id @@ -127,3 +146,5 @@ export class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { } } } + +module.exports = { DocusaurusMarkdownFeature } diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/index.ts b/tools/xstate-api-documenter-docusaurus-plugin/src/index.js similarity index 55% rename from tools/xstate-api-documenter-docusaurus-plugin/src/index.ts rename to tools/xstate-api-documenter-docusaurus-plugin/src/index.js index 59aa8ed55..2af257b7e 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/index.ts +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/index.js @@ -1,10 +1,11 @@ +// Based on https://github.com/microsoft/rushstack-websites/tree/5335470/tools/api-documenter-docusaurus-plugin + // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. -import { IApiDocumenterPluginManifest } from '@microsoft/api-documenter'; -import { DocusaurusMarkdownFeature } from './DocusaurusMarkdownFeature'; +const { DocusaurusMarkdownFeature } = require('./DocusaurusMarkdownFeature.js'); -export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = { +const apiDocumenterPluginManifest = { manifestVersion: 1000, features: [ { @@ -14,3 +15,5 @@ export const apiDocumenterPluginManifest: IApiDocumenterPluginManifest = { } ] }; + +module.exports = { apiDocumenterPluginManifest } From becda8cf151670357bd08257dea59d99c66807ba Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 21:39:10 -0500 Subject: [PATCH 30/43] don't autogenerate api sidebar --- sidebars.js | 7 ------- 1 file changed, 7 deletions(-) diff --git a/sidebars.js b/sidebars.js index b81234f29..19a471a44 100644 --- a/sidebars.js +++ b/sidebars.js @@ -348,13 +348,6 @@ const sidebars = { label: 'Glossary', id: 'glossary', }, - ], - - api: [ - { - type: 'autogenerated', - dirName: 'api' - } ] }; From fcb77573a1f84b978c8b7d85cad24fa2b2f2c094 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 21:42:49 -0500 Subject: [PATCH 31/43] slightly less top margin for API Doc title --- src/css/custom.css | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/src/css/custom.css b/src/css/custom.css index f8c90859b..c02a2a748 100644 --- a/src/css/custom.css +++ b/src/css/custom.css @@ -1950,3 +1950,10 @@ html:not(.plugin-id-xstate-react-api) .docsVersionDropdown--xstate-react-api { display: none; } */ + +/* slightly less top margin for API Doc title */ +.plugin-id-xstate-api .theme-doc-markdown.markdown > h2 { + /* margin-top: 4.5rem; */ + /* --ifm-h2-font-size: 1.5rem; */ + margin-top: 1.5rem; +} From 5bf077cfe913b1d21c360353ba4d1560acf1459f Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 21:43:32 -0500 Subject: [PATCH 32/43] docs --- tools/xstate-api-documenter-docusaurus-plugin/src/index.js | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/index.js b/tools/xstate-api-documenter-docusaurus-plugin/src/index.js index 2af257b7e..b2354d4fe 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/index.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/index.js @@ -1,4 +1,8 @@ -// Based on https://github.com/microsoft/rushstack-websites/tree/5335470/tools/api-documenter-docusaurus-plugin +// XState-specific plugin to format API Documenter output for Docusaurus +// +// Adapted from https://github.com/microsoft/rushstack-websites/tree/5335470/tools/api-documenter-docusaurus-plugin +// +// API Documenter Plugin API reference: https://api.rushstack.io/pages/api-documenter // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. From de5f1e88a4a52ea818efffb88f63e1ac95c792be Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 22:01:42 -0500 Subject: [PATCH 33/43] docs --- .../src/DocusaurusMarkdownFeature.js | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index 1ff3354ff..069b3ee34 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -1,4 +1,4 @@ -// See: https://api.rushstack.io/pages/api-documenter +// Adapted from https://github.com/microsoft/rushstack-websites/tree/5335470/tools/api-documenter-docusaurus-plugin // Copyright (c) Microsoft Corporation. All rights reserved. Licensed under the MIT license. // See LICENSE in the project root for license information. @@ -40,11 +40,14 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { // Add the Docusaurus frontmatter const header = [ `---`, - // Generated API docs have a built-in title header below the breadcrumbs + // Generated API docs have a built-in title header below the Markdown breadcrumbs // `title: ${JSON.stringify(eventArgs.apiItem.displayName)}`, `hide_title: true`, - // Suppress the default Edit button and Next/Prev links for API docs + + // Suppress the default Edit button `custom_edit_url: null`, + // suppress the Next/Prev links for API docs + // because the link text is just the filename `pagination_prev: null`, `pagination_next: null`, `---`, @@ -63,8 +66,8 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { // However empty React fragments have an equivalent effect: eventArgs.pageContent = eventArgs.pageContent.replace(//g, '<>'); - // try to remove breadcrumbs - // by removing any lines that start with [Home] + // try to remove API Documenter breadcrumbs to prefer Docusaurus breadcrumbs instead + // removes any lines in the Markdown ouput that start with [Home] eventArgs.pageContent = eventArgs.pageContent.replace(/\[Home\]\(.\/index.md\) >.+/, ''); this._apiItemsWithPages.add(eventArgs.apiItem); @@ -77,6 +80,7 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { */ onFinished(eventArgs) { // const navigationFile: INavigationFile = { + // generate a categorized sidebar.json which can be loaded by Docusaurus // type: 'category', // label: 'API Reference', // items: [ From 297111b44f4188329b1e5100cbf84335cc7ce9e4 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 22:02:38 -0500 Subject: [PATCH 34/43] log --- .../src/DocusaurusMarkdownFeature.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index 069b3ee34..2fc4e74f6 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -99,7 +99,7 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { const navFilePath = path.join(this.context.outputFolder, '..', '..', 'sidebar-xstate-api.json'); const navFileContent = JSON.stringify(navigationFile, undefined, 2); - console.log('writing:', navFilePath); + console.log('Writing', navFilePath); fs.writeFileSync(navFilePath, navFileContent); } From 276879ff8903353479c7da9b8d5147ff5dc6a995 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 22:02:59 -0500 Subject: [PATCH 35/43] comment js --- .../src/DocusaurusMarkdownFeature.js | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index 2fc4e74f6..8bf7e9f2b 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -79,10 +79,10 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { * @returns {void} */ onFinished(eventArgs) { - // const navigationFile: INavigationFile = { // generate a categorized sidebar.json which can be loaded by Docusaurus + // const navigationFile = { // type: 'category', - // label: 'API Reference', + // label: 'API', // items: [ // { // type: 'doc', @@ -91,7 +91,7 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { // } // ] // }; - // this._buildNavigation(navigationFile.items!, this.context.apiModel); + // this._buildNavigation(navigationFile.items, this.context.apiModel); let navigationFile = [] this._buildNavigation(navigationFile, this.context.apiModel); From 9eb647dcad560078e033a00bbfce44d1715144a6 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 22:36:24 -0500 Subject: [PATCH 36/43] top-level XState API reference override --- sidebar-xstate-api.json | 4 ++-- .../src/DocusaurusMarkdownFeature.js | 18 ++++++++++++++++-- 2 files changed, 18 insertions(+), 4 deletions(-) diff --git a/sidebar-xstate-api.json b/sidebar-xstate-api.json index aebdffd36..56d583ee1 100644 --- a/sidebar-xstate-api.json +++ b/sidebar-xstate-api.json @@ -1,10 +1,10 @@ [ { "type": "category", - "label": "xstate", + "label": "XState API", "link": { "type": "doc", - "id": "xstate" + "id": "index" }, "items": [ { diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index 8bf7e9f2b..7adcd6591 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -101,6 +101,14 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { console.log('Writing', navFilePath); fs.writeFileSync(navFilePath, navFileContent); + + fs.copyFileSync( + path.join(this.context.outputFolder, 'xstate.md'), + path.join(this.context.outputFolder, 'index.md') + ) + fs.rmSync( + path.join(this.context.outputFolder, 'xstate.md') + ) } /** @@ -112,9 +120,9 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { _buildNavigation(parentNodes, parentApiItem) { for (const apiItem of parentApiItem.members) { if (this._apiItemsWithPages.has(apiItem)) { - const label = apiItem.displayName; + let label = apiItem.displayName; - const id = path.posix + let id = path.posix .join(this.context.documenter.getLinkForApiItem(apiItem)) .replace(/\.md$/, '') .replace(/\/$/, '/index'); @@ -122,6 +130,12 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { this._buildNavigation(children, apiItem); if (children.length > 0) { + // special case to rename top-level + if (id == 'xstate') { + label = 'XState API' + id = 'index' + } + const newNode = { type: 'category', label, From ab57be309c045ca98b6a8a3e01525b89067994ec Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 22:36:29 -0500 Subject: [PATCH 37/43] cleanup --- .../src/DocusaurusMarkdownFeature.js | 1 + 1 file changed, 1 insertion(+) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index 7adcd6591..e81391a8f 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -46,6 +46,7 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { // Suppress the default Edit button `custom_edit_url: null`, + // suppress the Next/Prev links for API docs // because the link text is just the filename `pagination_prev: null`, From e8c2b2f8edfa350a3f7eca2d18ef80942c9f8b60 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Sun, 22 Oct 2023 22:42:50 -0500 Subject: [PATCH 38/43] cleanup unused code --- .../src/DocusaurusMarkdownFeature.js | 22 +------------------ 1 file changed, 1 insertion(+), 21 deletions(-) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index e81391a8f..63e72a474 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -81,19 +81,6 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { */ onFinished(eventArgs) { // generate a categorized sidebar.json which can be loaded by Docusaurus - // const navigationFile = { - // type: 'category', - // label: 'API', - // items: [ - // { - // type: 'doc', - // label: '(members)', - // id: 'index' - // } - // ] - // }; - // this._buildNavigation(navigationFile.items, this.context.apiModel); - let navigationFile = [] this._buildNavigation(navigationFile, this.context.apiModel); @@ -141,14 +128,7 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { type: 'category', label, link: { type: 'doc', id }, - items: [ - // { - // type: 'doc', - // label: '(members)', - // id - // }, - ...children - ] + items: children }; parentNodes.push(newNode); } else { From d21d7b6f827b6e39f914f0ff58139c203efa28e0 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Mon, 23 Oct 2023 09:51:58 -0500 Subject: [PATCH 39/43] index doc at top-level (not category) --- .../src/DocusaurusMarkdownFeature.js | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index 63e72a474..e571e5b1e 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -81,8 +81,15 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { */ onFinished(eventArgs) { // generate a categorized sidebar.json which can be loaded by Docusaurus - let navigationFile = [] - this._buildNavigation(navigationFile, this.context.apiModel); + const navigationFile = [ + // special case to for top-level index + { + type: 'doc', + label: '(index)', + id: 'index' + } + ]; + this._buildNavigation(navigationFile, this.context.apiModel.members[0]); const navFilePath = path.join(this.context.outputFolder, '..', '..', 'sidebar-xstate-api.json'); const navFileContent = JSON.stringify(navigationFile, undefined, 2); @@ -118,12 +125,6 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { this._buildNavigation(children, apiItem); if (children.length > 0) { - // special case to rename top-level - if (id == 'xstate') { - label = 'XState API' - id = 'index' - } - const newNode = { type: 'category', label, From e0d4b97e79553563e0d41027291df14da3417bf4 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Mon, 23 Oct 2023 09:53:39 -0500 Subject: [PATCH 40/43] use displayName for HTML title instead of filename --- .../src/DocusaurusMarkdownFeature.js | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js index e571e5b1e..9d3c23bfa 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js +++ b/tools/xstate-api-documenter-docusaurus-plugin/src/DocusaurusMarkdownFeature.js @@ -41,7 +41,8 @@ class DocusaurusMarkdownFeature extends MarkdownDocumenterFeature { const header = [ `---`, // Generated API docs have a built-in title header below the Markdown breadcrumbs - // `title: ${JSON.stringify(eventArgs.apiItem.displayName)}`, + // Also used as HTML title + `title: ${JSON.stringify(eventArgs.apiItem.displayName)}`, `hide_title: true`, // Suppress the default Edit button From 3d44d03011438384469fe1d6db0a43e226b1819d Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Mon, 23 Oct 2023 10:11:22 -0500 Subject: [PATCH 41/43] sidebar-xstate-api.json with index item --- sidebar-xstate-api.json | 5201 +++++++++++++++++++-------------------- 1 file changed, 2598 insertions(+), 2603 deletions(-) diff --git a/sidebar-xstate-api.json b/sidebar-xstate-api.json index 56d583ee1..ecef11f20 100644 --- a/sidebar-xstate-api.json +++ b/sidebar-xstate-api.json @@ -1,2962 +1,2957 @@ [ + { + "type": "doc", + "label": "(index)", + "id": "index" + }, + { + "type": "doc", + "label": "__ResolvedTypesMetaFrom", + "id": "xstate.__resolvedtypesmetafrom" + }, + { + "type": "doc", + "label": "Action", + "id": "xstate.action" + }, + { + "type": "category", + "label": "ActionArgs", + "link": { + "type": "doc", + "id": "xstate.actionargs" + }, + "items": [ + { + "type": "doc", + "label": "action", + "id": "xstate.actionargs.action" + } + ] + }, + { + "type": "doc", + "label": "ActionFunction", + "id": "xstate.actionfunction" + }, + { + "type": "doc", + "label": "ActionFunctionMap", + "id": "xstate.actionfunctionmap" + }, + { + "type": "doc", + "label": "Actions", + "id": "xstate.actions" + }, + { + "type": "category", + "label": "Actor", + "link": { + "type": "doc", + "id": "xstate.actor" + }, + "items": [ + { + "type": "doc", + "label": "_parent", + "id": "xstate.actor._parent" + }, + { + "type": "doc", + "label": "[symbolObservable]", + "id": "xstate.actor._symbolobservable_" + }, + { + "type": "doc", + "label": "(constructor)", + "id": "xstate.actor._constructor_" + }, + { + "type": "doc", + "label": "cancel", + "id": "xstate.actor.cancel" + }, + { + "type": "doc", + "label": "clock", + "id": "xstate.actor.clock" + }, + { + "type": "doc", + "label": "delaySend", + "id": "xstate.actor.delaysend" + }, + { + "type": "doc", + "label": "getPersistedState", + "id": "xstate.actor.getpersistedstate" + }, + { + "type": "doc", + "label": "getSnapshot", + "id": "xstate.actor.getsnapshot" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.actor.id" + }, + { + "type": "doc", + "label": "logic", + "id": "xstate.actor.logic" + }, + { + "type": "doc", + "label": "options", + "id": "xstate.actor.options" + }, + { + "type": "doc", + "label": "ref", + "id": "xstate.actor.ref" + }, + { + "type": "doc", + "label": "send", + "id": "xstate.actor.send" + }, + { + "type": "doc", + "label": "sessionId", + "id": "xstate.actor.sessionid" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.actor.src" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.actor.start" + }, + { + "type": "doc", + "label": "status", + "id": "xstate.actor.status" + }, + { + "type": "doc", + "label": "stop", + "id": "xstate.actor.stop" + }, + { + "type": "doc", + "label": "subscribe", + "id": "xstate.actor.subscribe" + }, + { + "type": "doc", + "label": "subscribe", + "id": "xstate.actor.subscribe_1" + }, + { + "type": "doc", + "label": "system", + "id": "xstate.actor.system" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.actor.tojson" + } + ] + }, + { + "type": "category", + "label": "ActorContext", + "link": { + "type": "doc", + "id": "xstate.actorcontext" + }, + "items": [ + { + "type": "doc", + "label": "defer", + "id": "xstate.actorcontext.defer" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.actorcontext.id" + }, + { + "type": "doc", + "label": "logger", + "id": "xstate.actorcontext.logger" + }, + { + "type": "doc", + "label": "self", + "id": "xstate.actorcontext.self" + }, + { + "type": "doc", + "label": "sessionId", + "id": "xstate.actorcontext.sessionid" + }, + { + "type": "doc", + "label": "stopChild", + "id": "xstate.actorcontext.stopchild" + }, + { + "type": "doc", + "label": "system", + "id": "xstate.actorcontext.system" + } + ] + }, + { + "type": "category", + "label": "ActorLike", + "link": { + "type": "doc", + "id": "xstate.actorlike" + }, + "items": [ + { + "type": "doc", + "label": "send", + "id": "xstate.actorlike.send" + } + ] + }, + { + "type": "category", + "label": "ActorLogic", + "link": { + "type": "doc", + "id": "xstate.actorlogic" + }, + "items": [ + { + "type": "doc", + "label": "config", + "id": "xstate.actorlogic.config" + }, + { + "type": "doc", + "label": "getInitialState", + "id": "xstate.actorlogic.getinitialstate" + }, + { + "type": "doc", + "label": "getPersistedState", + "id": "xstate.actorlogic.getpersistedstate" + }, + { + "type": "doc", + "label": "restoreState", + "id": "xstate.actorlogic.restorestate" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.actorlogic.start" + }, + { + "type": "doc", + "label": "transition", + "id": "xstate.actorlogic.transition" + } + ] + }, + { + "type": "doc", + "label": "ActorLogicFrom", + "id": "xstate.actorlogicfrom" + }, + { + "type": "category", + "label": "ActorOptions", + "link": { + "type": "doc", + "id": "xstate.actoroptions" + }, + "items": [ + { + "type": "doc", + "label": "clock", + "id": "xstate.actoroptions.clock" + }, + { + "type": "doc", + "label": "devTools", + "id": "xstate.actoroptions.devtools" + }, + { + "type": "doc", + "label": "execute", + "id": "xstate.actoroptions.execute" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.actoroptions.id" + }, + { + "type": "doc", + "label": "input", + "id": "xstate.actoroptions.input" + }, + { + "type": "doc", + "label": "inspect", + "id": "xstate.actoroptions.inspect" + }, + { + "type": "doc", + "label": "logger", + "id": "xstate.actoroptions.logger" + }, + { + "type": "doc", + "label": "parent", + "id": "xstate.actoroptions.parent" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.actoroptions.src" + }, + { + "type": "doc", + "label": "state", + "id": "xstate.actoroptions.state" + }, + { + "type": "doc", + "label": "sync", + "id": "xstate.actoroptions.sync" + }, + { + "type": "doc", + "label": "systemId", + "id": "xstate.actoroptions.systemid" + } + ] + }, + { + "type": "category", + "label": "ActorRef", + "link": { + "type": "doc", + "id": "xstate.actorref" + }, + "items": [ + { + "type": "doc", + "label": "_parent", + "id": "xstate.actorref._parent" + }, + { + "type": "doc", + "label": "getPersistedState", + "id": "xstate.actorref.getpersistedstate" + }, + { + "type": "doc", + "label": "getSnapshot", + "id": "xstate.actorref.getsnapshot" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.actorref.id" + }, + { + "type": "doc", + "label": "send", + "id": "xstate.actorref.send" + }, + { + "type": "doc", + "label": "sessionId", + "id": "xstate.actorref.sessionid" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.actorref.src" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.actorref.start" + }, + { + "type": "doc", + "label": "status", + "id": "xstate.actorref.status" + }, + { + "type": "doc", + "label": "stop", + "id": "xstate.actorref.stop" + }, + { + "type": "doc", + "label": "system", + "id": "xstate.actorref.system" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.actorref.tojson" + } + ] + }, + { + "type": "doc", + "label": "ActorRefFrom", + "id": "xstate.actorreffrom" + }, + { + "type": "doc", + "label": "ActorStatus", + "id": "xstate.actorstatus" + }, + { + "type": "category", + "label": "ActorSystem", + "link": { + "type": "doc", + "id": "xstate.actorsystem" + }, + "items": [ + { + "type": "doc", + "label": "get", + "id": "xstate.actorsystem.get" + }, + { + "type": "doc", + "label": "inspect", + "id": "xstate.actorsystem.inspect" + } + ] + }, + { + "type": "category", + "label": "ActorSystemInfo", + "link": { + "type": "doc", + "id": "xstate.actorsysteminfo" + }, + "items": [ + { + "type": "doc", + "label": "actors", + "id": "xstate.actorsysteminfo.actors" + } + ] + }, + { + "type": "doc", + "label": "and", + "id": "xstate.and" + }, + { + "type": "doc", + "label": "AnyActor", + "id": "xstate.anyactor" + }, + { + "type": "doc", + "label": "AnyActorContext", + "id": "xstate.anyactorcontext" + }, + { + "type": "doc", + "label": "AnyActorLogic", + "id": "xstate.anyactorlogic" + }, + { + "type": "doc", + "label": "AnyActorRef", + "id": "xstate.anyactorref" + }, + { + "type": "doc", + "label": "AnyActorSystem", + "id": "xstate.anyactorsystem" + }, + { + "type": "doc", + "label": "AnyEventObject", + "id": "xstate.anyeventobject" + }, + { + "type": "doc", + "label": "AnyFunction", + "id": "xstate.anyfunction" + }, + { + "type": "doc", + "label": "AnyHistoryValue", + "id": "xstate.anyhistoryvalue" + }, + { + "type": "doc", + "label": "AnyInterpreter", + "id": "xstate.anyinterpreter" + }, + { + "type": "doc", + "label": "AnyInvokeConfig", + "id": "xstate.anyinvokeconfig" + }, + { + "type": "doc", + "label": "AnyState", + "id": "xstate.anystate" + }, + { + "type": "doc", + "label": "AnyStateConfig", + "id": "xstate.anystateconfig" + }, + { + "type": "doc", + "label": "AnyStateMachine", + "id": "xstate.anystatemachine" + }, + { + "type": "doc", + "label": "AnyStateNode", + "id": "xstate.anystatenode" + }, + { + "type": "doc", + "label": "AnyStateNodeConfig", + "id": "xstate.anystatenodeconfig" + }, + { + "type": "doc", + "label": "AnyStateNodeDefinition", + "id": "xstate.anystatenodedefinition" + }, + { + "type": "doc", + "label": "AnyTransitionConfig", + "id": "xstate.anytransitionconfig" + }, + { + "type": "doc", + "label": "AnyTransitionDefinition", + "id": "xstate.anytransitiondefinition" + }, + { + "type": "doc", + "label": "AreAllImplementationsAssumedToBeProvided", + "id": "xstate.areallimplementationsassumedtobeprovided" + }, + { + "type": "doc", + "label": "assign", + "id": "xstate.assign" + }, + { + "type": "category", + "label": "AssignAction", + "link": { + "type": "doc", + "id": "xstate.assignaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TActor", + "id": "xstate.assignaction._out_tactor" + } + ] + }, + { + "type": "category", + "label": "AssignArgs", + "link": { + "type": "doc", + "id": "xstate.assignargs" + }, + "items": [ + { + "type": "doc", + "label": "spawn", + "id": "xstate.assignargs.spawn" + } + ] + }, + { + "type": "doc", + "label": "Assigner", + "id": "xstate.assigner" + }, + { + "type": "category", + "label": "AtomicStateNodeConfig", + "link": { + "type": "doc", + "id": "xstate.atomicstatenodeconfig" + }, + "items": [ + { + "type": "doc", + "label": "initial", + "id": "xstate.atomicstatenodeconfig.initial" + }, + { + "type": "doc", + "label": "onDone", + "id": "xstate.atomicstatenodeconfig.ondone" + }, + { + "type": "doc", + "label": "parallel", + "id": "xstate.atomicstatenodeconfig.parallel" + }, + { + "type": "doc", + "label": "states", + "id": "xstate.atomicstatenodeconfig.states" + } + ] + }, + { + "type": "category", + "label": "BaseActorRef", + "link": { + "type": "doc", + "id": "xstate.baseactorref" + }, + "items": [ + { + "type": "doc", + "label": "send", + "id": "xstate.baseactorref.send" + } + ] + }, + { + "type": "doc", + "label": "CallbackActorLogic", + "id": "xstate.callbackactorlogic" + }, + { + "type": "doc", + "label": "cancel", + "id": "xstate.cancel" + }, + { + "type": "doc", + "label": "CancelAction", + "id": "xstate.cancelaction" + }, + { + "type": "doc", + "label": "Cast", + "id": "xstate.cast" + }, + { + "type": "doc", + "label": "choose", + "id": "xstate.choose" + }, + { + "type": "category", + "label": "ChooseAction", + "link": { + "type": "doc", + "id": "xstate.chooseaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TAction", + "id": "xstate.chooseaction._out_taction" + }, + { + "type": "doc", + "label": "_out_TActor", + "id": "xstate.chooseaction._out_tactor" + }, + { + "type": "doc", + "label": "_out_TDelay", + "id": "xstate.chooseaction._out_tdelay" + }, + { + "type": "doc", + "label": "_out_TGuard", + "id": "xstate.chooseaction._out_tguard" + } + ] + }, + { + "type": "category", + "label": "ChooseBranch", + "link": { + "type": "doc", + "id": "xstate.choosebranch" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.choosebranch.actions" + }, + { + "type": "doc", + "label": "guard", + "id": "xstate.choosebranch.guard" + } + ] + }, + { + "type": "doc", + "label": "Compute", + "id": "xstate.compute" + }, + { + "type": "doc", + "label": "ContextFactory", + "id": "xstate.contextfactory" + }, + { + "type": "doc", + "label": "ContextFrom", + "id": "xstate.contextfrom" + }, + { + "type": "doc", + "label": "createActor", + "id": "xstate.createactor" + }, + { + "type": "doc", + "label": "createActor", + "id": "xstate.createactor_1" + }, + { + "type": "doc", + "label": "createEmptyActor", + "id": "xstate.createemptyactor" + }, + { + "type": "doc", + "label": "createMachine", + "id": "xstate.createmachine" + }, + { + "type": "doc", + "label": "DelayConfig", + "id": "xstate.delayconfig" + }, + { + "type": "category", + "label": "DelayedTransitionDefinition", + "link": { + "type": "doc", + "id": "xstate.delayedtransitiondefinition" + }, + "items": [ + { + "type": "doc", + "label": "delay", + "id": "xstate.delayedtransitiondefinition.delay" + } + ] + }, + { + "type": "doc", + "label": "DelayedTransitions", + "id": "xstate.delayedtransitions" + }, + { + "type": "doc", + "label": "DelayExpr", + "id": "xstate.delayexpr" + }, + { + "type": "doc", + "label": "DelayFunctionMap", + "id": "xstate.delayfunctionmap" + }, + { + "type": "doc", + "label": "DevToolsAdapter", + "id": "xstate.devtoolsadapter" + }, + { + "type": "category", + "label": "DoneActorEvent", + "link": { + "type": "doc", + "id": "xstate.doneactorevent" + }, + "items": [ + { + "type": "doc", + "label": "output", + "id": "xstate.doneactorevent.output" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.doneactorevent.type" + } + ] + }, + { + "type": "category", + "label": "DoneStateEvent", + "link": { + "type": "doc", + "id": "xstate.donestateevent" + }, + "items": [ + { + "type": "doc", + "label": "output", + "id": "xstate.donestateevent.output" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.donestateevent.type" + } + ] + }, + { + "type": "doc", + "label": "Equals", + "id": "xstate.equals" + }, + { + "type": "category", + "label": "ErrorActorEvent", + "link": { + "type": "doc", + "id": "xstate.erroractorevent" + }, + "items": [ + { + "type": "doc", + "label": "data", + "id": "xstate.erroractorevent.data" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.erroractorevent.type" + } + ] + }, + { + "type": "doc", + "label": "escalate", + "id": "xstate.escalate" + }, + { + "type": "doc", + "label": "EventDescriptor", + "id": "xstate.eventdescriptor" + }, + { + "type": "doc", + "label": "EventFrom", + "id": "xstate.eventfrom" + }, + { + "type": "doc", + "label": "EventFromLogic", + "id": "xstate.eventfromlogic" + }, + { + "type": "category", + "label": "EventObject", + "link": { + "type": "doc", + "id": "xstate.eventobject" + }, + "items": [ + { + "type": "doc", + "label": "type", + "id": "xstate.eventobject.type" + } + ] + }, + { + "type": "doc", + "label": "ExtractEvent", + "id": "xstate.extractevent" + }, + { + "type": "doc", + "label": "forwardTo", + "id": "xstate.forwardto" + }, + { + "type": "doc", + "label": "fromCallback", + "id": "xstate.fromcallback" + }, + { + "type": "doc", + "label": "fromEventObservable", + "id": "xstate.fromeventobservable" + }, + { + "type": "doc", + "label": "fromObservable", + "id": "xstate.fromobservable" + }, + { + "type": "doc", + "label": "fromPromise", + "id": "xstate.frompromise" + }, + { + "type": "doc", + "label": "fromTransition", + "id": "xstate.fromtransition" + }, + { + "type": "doc", + "label": "getStateNodes", + "id": "xstate.getstatenodes" + }, + { + "type": "category", + "label": "HistoryStateNode", + "link": { + "type": "doc", + "id": "xstate.historystatenode" + }, + "items": [ + { + "type": "doc", + "label": "history", + "id": "xstate.historystatenode.history" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.historystatenode.target" + } + ] + }, + { + "type": "category", + "label": "HistoryStateNodeConfig", + "link": { + "type": "doc", + "id": "xstate.historystatenodeconfig" + }, + "items": [ + { + "type": "doc", + "label": "history", + "id": "xstate.historystatenodeconfig.history" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.historystatenodeconfig.target" + } + ] + }, + { + "type": "doc", + "label": "HistoryValue", + "id": "xstate.historyvalue" + }, + { + "type": "doc", + "label": "HomomorphicOmit", + "id": "xstate.homomorphicomit" + }, + { + "type": "doc", + "label": "HomomorphicPick", + "id": "xstate.homomorphicpick" + }, + { + "type": "doc", + "label": "IndexByProp", + "id": "xstate.indexbyprop" + }, + { + "type": "doc", + "label": "IndexByType", + "id": "xstate.indexbytype" + }, + { + "type": "doc", + "label": "InferEvent", + "id": "xstate.inferevent" + }, + { + "type": "category", + "label": "InitialTransitionConfig", + "link": { + "type": "doc", + "id": "xstate.initialtransitionconfig" + }, + "items": [ + { + "type": "doc", + "label": "target", + "id": "xstate.initialtransitionconfig.target" + } + ] + }, + { + "type": "category", + "label": "InitialTransitionDefinition", + "link": { + "type": "doc", + "id": "xstate.initialtransitiondefinition" + }, + "items": [ + { + "type": "doc", + "label": "guard", + "id": "xstate.initialtransitiondefinition.guard" + }, + { + "type": "doc", + "label": "target", + "id": "xstate.initialtransitiondefinition.target" + } + ] + }, + { + "type": "doc", + "label": "InputFrom", + "id": "xstate.inputfrom" + }, + { + "type": "category", + "label": "InspectedActorEvent", + "link": { + "type": "doc", + "id": "xstate.inspectedactorevent" + }, + "items": [ + { + "type": "doc", + "label": "actorRef", + "id": "xstate.inspectedactorevent.actorref" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.inspectedactorevent.type" + } + ] + }, + { + "type": "category", + "label": "InspectedEventEvent", + "link": { + "type": "doc", + "id": "xstate.inspectedeventevent" + }, + "items": [ + { + "type": "doc", + "label": "event", + "id": "xstate.inspectedeventevent.event" + }, + { + "type": "doc", + "label": "sourceRef", + "id": "xstate.inspectedeventevent.sourceref" + }, + { + "type": "doc", + "label": "targetRef", + "id": "xstate.inspectedeventevent.targetref" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.inspectedeventevent.type" + } + ] + }, + { + "type": "category", + "label": "InspectedSnapshotEvent", + "link": { + "type": "doc", + "id": "xstate.inspectedsnapshotevent" + }, + "items": [ + { + "type": "doc", + "label": "actorRef", + "id": "xstate.inspectedsnapshotevent.actorref" + }, + { + "type": "doc", + "label": "event", + "id": "xstate.inspectedsnapshotevent.event" + }, + { + "type": "doc", + "label": "snapshot", + "id": "xstate.inspectedsnapshotevent.snapshot" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.inspectedsnapshotevent.type" + } + ] + }, + { + "type": "doc", + "label": "InspectionEvent", + "id": "xstate.inspectionevent" + }, + { + "type": "doc", + "label": "InternalMachineImplementations", + "id": "xstate.internalmachineimplementations" + }, + { + "type": "category", + "label": "InteropObservable", + "link": { + "type": "doc", + "id": "xstate.interopobservable" + }, + "items": [ + { + "type": "doc", + "label": "[Symbol.observable]", + "id": "xstate.interopobservable._symbol.observable_" + } + ] + }, + { + "type": "category", + "label": "InteropSubscribable", + "link": { + "type": "doc", + "id": "xstate.interopsubscribable" + }, + "items": [ + { + "type": "doc", + "label": "subscribe", + "id": "xstate.interopsubscribable.subscribe" + } + ] + }, + { + "type": "doc", + "label": "interpret", + "id": "xstate.interpret" + }, + { + "type": "doc", + "label": "Interpreter", + "id": "xstate.interpreter" + }, + { + "type": "doc", + "label": "InterpreterFrom", + "id": "xstate.interpreterfrom" + }, + { + "type": "doc", + "label": "InterpreterStatus", + "id": "xstate.interpreterstatus" + }, + { + "type": "doc", + "label": "InvokeConfig", + "id": "xstate.invokeconfig" + }, + { + "type": "category", + "label": "InvokeDefinition", + "link": { + "type": "doc", + "id": "xstate.invokedefinition" + }, + "items": [ + { + "type": "doc", + "label": "id", + "id": "xstate.invokedefinition.id" + }, + { + "type": "doc", + "label": "input", + "id": "xstate.invokedefinition.input" + }, + { + "type": "doc", + "label": "onDone", + "id": "xstate.invokedefinition.ondone" + }, + { + "type": "doc", + "label": "onError", + "id": "xstate.invokedefinition.onerror" + }, + { + "type": "doc", + "label": "onSnapshot", + "id": "xstate.invokedefinition.onsnapshot" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.invokedefinition.src" + }, + { + "type": "doc", + "label": "systemId", + "id": "xstate.invokedefinition.systemid" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.invokedefinition.tojson" + } + ] + }, + { + "type": "doc", + "label": "IsAny", + "id": "xstate.isany" + }, + { + "type": "doc", + "label": "IsLiteralString", + "id": "xstate.isliteralstring" + }, + { + "type": "doc", + "label": "IsNever", + "id": "xstate.isnever" + }, + { + "type": "doc", + "label": "Lazy", + "id": "xstate.lazy" + }, + { + "type": "doc", + "label": "log", + "id": "xstate.log" + }, + { + "type": "doc", + "label": "LogAction", + "id": "xstate.logaction" + }, + { + "type": "doc", + "label": "LogExpr", + "id": "xstate.logexpr" + }, + { + "type": "doc", + "label": "LowInfer", + "id": "xstate.lowinfer" + }, + { + "type": "doc", + "label": "MachineConfig", + "id": "xstate.machineconfig" + }, + { + "type": "doc", + "label": "MachineContext", + "id": "xstate.machinecontext" + }, + { + "type": "doc", + "label": "MachineImplementations", + "id": "xstate.machineimplementations" + }, + { + "type": "doc", + "label": "MachineImplementationsFrom", + "id": "xstate.machineimplementationsfrom" + }, + { + "type": "category", + "label": "MachineImplementationsSimplified", + "link": { + "type": "doc", + "id": "xstate.machineimplementationssimplified" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.machineimplementationssimplified.actions" + }, + { + "type": "doc", + "label": "actors", + "id": "xstate.machineimplementationssimplified.actors" + }, + { + "type": "doc", + "label": "delays", + "id": "xstate.machineimplementationssimplified.delays" + }, + { + "type": "doc", + "label": "guards", + "id": "xstate.machineimplementationssimplified.guards" + } + ] + }, + { + "type": "doc", + "label": "MachineSnapshot", + "id": "xstate.machinesnapshot" + }, + { + "type": "category", + "label": "MachineTypes", + "link": { + "type": "doc", + "id": "xstate.machinetypes" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.machinetypes.actions" + }, + { + "type": "doc", + "label": "actors", + "id": "xstate.machinetypes.actors" + }, + { + "type": "doc", + "label": "context", + "id": "xstate.machinetypes.context" + }, + { + "type": "doc", + "label": "delays", + "id": "xstate.machinetypes.delays" + }, + { + "type": "doc", + "label": "events", + "id": "xstate.machinetypes.events" + }, + { + "type": "doc", + "label": "guards", + "id": "xstate.machinetypes.guards" + }, + { + "type": "doc", + "label": "input", + "id": "xstate.machinetypes.input" + }, + { + "type": "doc", + "label": "output", + "id": "xstate.machinetypes.output" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.machinetypes.tags" + }, + { + "type": "doc", + "label": "typegen", + "id": "xstate.machinetypes.typegen" + } + ] + }, + { + "type": "doc", + "label": "Mapper", + "id": "xstate.mapper" + }, + { + "type": "doc", + "label": "mapState", + "id": "xstate.mapstate" + }, + { + "type": "category", + "label": "MarkAllImplementationsAsProvided", + "link": { + "type": "doc", + "id": "xstate.markallimplementationsasprovided" + }, + "items": [ + { + "type": "doc", + "label": "\"@@xstate/typegen\"", + "id": "xstate.markallimplementationsasprovided.___xstate_typegen_" + }, + { + "type": "doc", + "label": "resolved", + "id": "xstate.markallimplementationsasprovided.resolved" + } + ] + }, + { + "type": "doc", + "label": "matchesState", + "id": "xstate.matchesstate" + }, + { + "type": "doc", + "label": "MaybeLazy", + "id": "xstate.maybelazy" + }, + { + "type": "doc", + "label": "Merge", + "id": "xstate.merge" + }, + { + "type": "doc", + "label": "MetaObject", + "id": "xstate.metaobject" + }, + { + "type": "doc", + "label": "MissingImplementationsError", + "id": "xstate.missingimplementationserror" + }, + { + "type": "doc", + "label": "NoInfer", + "id": "xstate.noinfer" + }, + { + "type": "doc", + "label": "NonReducibleUnknown", + "id": "xstate.nonreducibleunknown" + }, + { + "type": "doc", + "label": "NoRequiredParams", + "id": "xstate.norequiredparams" + }, + { + "type": "doc", + "label": "not", + "id": "xstate.not" + }, + { + "type": "doc", + "label": "ObservableActorLogic", + "id": "xstate.observableactorlogic" + }, + { + "type": "doc", + "label": "Observer", + "id": "xstate.observer" + }, + { + "type": "doc", + "label": "or", + "id": "xstate.or" + }, + { + "type": "doc", + "label": "OutputFrom", + "id": "xstate.outputfrom" + }, + { + "type": "category", + "label": "ParameterizedObject", + "link": { + "type": "doc", + "id": "xstate.parameterizedobject" + }, + "items": [ + { + "type": "doc", + "label": "params", + "id": "xstate.parameterizedobject.params" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.parameterizedobject.type" + } + ] + }, + { + "type": "doc", + "label": "PartialAssigner", + "id": "xstate.partialassigner" + }, + { + "type": "doc", + "label": "pathToStateValue", + "id": "xstate.pathtostatevalue" + }, + { + "type": "doc", + "label": "PersistedMachineState", + "id": "xstate.persistedmachinestate" + }, + { + "type": "doc", + "label": "PersistedStateFrom", + "id": "xstate.persistedstatefrom" + }, + { + "type": "doc", + "label": "PromiseActorLogic", + "id": "xstate.promiseactorlogic" + }, + { + "type": "doc", + "label": "Prop", + "id": "xstate.prop" + }, + { + "type": "doc", + "label": "PropertyAssigner", + "id": "xstate.propertyassigner" + }, + { + "type": "category", + "label": "ProvidedActor", + "link": { + "type": "doc", + "id": "xstate.providedactor" + }, + "items": [ + { + "type": "doc", + "label": "id", + "id": "xstate.providedactor.id" + }, + { + "type": "doc", + "label": "logic", + "id": "xstate.providedactor.logic" + }, + { + "type": "doc", + "label": "src", + "id": "xstate.providedactor.src" + } + ] + }, + { + "type": "doc", + "label": "pure", + "id": "xstate.pure" + }, + { + "type": "category", + "label": "PureAction", + "link": { + "type": "doc", + "id": "xstate.pureaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TAction", + "id": "xstate.pureaction._out_taction" + }, + { + "type": "doc", + "label": "_out_TActor", + "id": "xstate.pureaction._out_tactor" + }, + { + "type": "doc", + "label": "_out_TDelay", + "id": "xstate.pureaction._out_tdelay" + }, + { + "type": "doc", + "label": "_out_TEvent", + "id": "xstate.pureaction._out_tevent" + }, + { + "type": "doc", + "label": "_out_TGuard", + "id": "xstate.pureaction._out_tguard" + } + ] + }, + { + "type": "doc", + "label": "raise", + "id": "xstate.raise" + }, + { + "type": "category", + "label": "RaiseAction", + "link": { + "type": "doc", + "id": "xstate.raiseaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TDelay", + "id": "xstate.raiseaction._out_tdelay" + }, + { + "type": "doc", + "label": "_out_TEvent", + "id": "xstate.raiseaction._out_tevent" + } + ] + }, + { + "type": "category", + "label": "RaiseActionOptions", + "link": { + "type": "doc", + "id": "xstate.raiseactionoptions" + }, + "items": [ + { + "type": "doc", + "label": "delay", + "id": "xstate.raiseactionoptions.delay" + }, + { + "type": "doc", + "label": "id", + "id": "xstate.raiseactionoptions.id" + } + ] + }, + { + "type": "category", + "label": "RaiseActionParams", + "link": { + "type": "doc", + "id": "xstate.raiseactionparams" + }, + "items": [ + { + "type": "doc", + "label": "event", + "id": "xstate.raiseactionparams.event" + } + ] + }, + { + "type": "category", + "label": "ResolvedTypegenMeta", + "link": { + "type": "doc", + "id": "xstate.resolvedtypegenmeta" + }, + "items": [ + { + "type": "doc", + "label": "resolved", + "id": "xstate.resolvedtypegenmeta.resolved" + } + ] + }, + { + "type": "category", + "label": "ResolveTypegenMeta", + "link": { + "type": "doc", + "id": "xstate.resolvetypegenmeta" + }, + "items": [ + { + "type": "doc", + "label": "\"@@xstate/typegen\"", + "id": "xstate.resolvetypegenmeta.___xstate_typegen_" + }, + { + "type": "doc", + "label": "resolved", + "id": "xstate.resolvetypegenmeta.resolved" + } + ] + }, + { + "type": "doc", + "label": "SendExpr", + "id": "xstate.sendexpr" + }, + { + "type": "doc", + "label": "sendParent", + "id": "xstate.sendparent" + }, + { + "type": "doc", + "label": "sendTo", + "id": "xstate.sendto" + }, + { + "type": "category", + "label": "SendToAction", + "link": { + "type": "doc", + "id": "xstate.sendtoaction" + }, + "items": [ + { + "type": "doc", + "label": "_out_TDelay", + "id": "xstate.sendtoaction._out_tdelay" + } + ] + }, + { + "type": "doc", + "label": "SendToActionOptions", + "id": "xstate.sendtoactionoptions" + }, + { + "type": "category", + "label": "SendToActionParams", + "link": { + "type": "doc", + "id": "xstate.sendtoactionparams" + }, + "items": [ + { + "type": "doc", + "label": "event", + "id": "xstate.sendtoactionparams.event" + } + ] + }, + { + "type": "doc", + "label": "SimpleOrStateNodeConfig", + "id": "xstate.simpleorstatenodeconfig" + }, + { + "type": "category", + "label": "SimulatedClock", + "link": { + "type": "doc", + "id": "xstate.simulatedclock" + }, + "items": [ + { + "type": "doc", + "label": "clearTimeout", + "id": "xstate.simulatedclock.cleartimeout" + }, + { + "type": "doc", + "label": "now", + "id": "xstate.simulatedclock.now" + }, + { + "type": "doc", + "label": "setTimeout", + "id": "xstate.simulatedclock.settimeout" + } + ] + }, + { + "type": "category", + "label": "SimulatedClock", + "link": { + "type": "doc", + "id": "xstate.simulatedclock" + }, + "items": [ + { + "type": "doc", + "label": "increment", + "id": "xstate.simulatedclock.increment" + }, + { + "type": "doc", + "label": "set", + "id": "xstate.simulatedclock.set" + }, + { + "type": "doc", + "label": "start", + "id": "xstate.simulatedclock.start" + } + ] + }, + { + "type": "doc", + "label": "SingleOrArray", + "id": "xstate.singleorarray" + }, + { + "type": "doc", + "label": "Snapshot", + "id": "xstate.snapshot" + }, + { + "type": "category", + "label": "SnapshotEvent", + "link": { + "type": "doc", + "id": "xstate.snapshotevent" + }, + "items": [ + { + "type": "doc", + "label": "snapshot", + "id": "xstate.snapshotevent.snapshot" + }, + { + "type": "doc", + "label": "type", + "id": "xstate.snapshotevent.type" + } + ] + }, + { + "type": "doc", + "label": "SnapshotFrom", + "id": "xstate.snapshotfrom" + }, + { + "type": "doc", + "label": "Spawner", + "id": "xstate.spawner" + }, + { + "type": "doc", + "label": "SpecialTargets", + "id": "xstate.specialtargets" + }, + { + "type": "category", + "label": "State", + "link": { + "type": "doc", + "id": "xstate.state" + }, + "items": [ + { + "type": "doc", + "label": "(constructor)", + "id": "xstate.state._constructor_" + }, + { + "type": "doc", + "label": "can", + "id": "xstate.state.can" + }, + { + "type": "doc", + "label": "children", + "id": "xstate.state.children" + }, + { + "type": "doc", + "label": "configuration", + "id": "xstate.state.configuration" + }, + { + "type": "doc", + "label": "context", + "id": "xstate.state.context" + }, + { + "type": "doc", + "label": "error", + "id": "xstate.state.error" + }, + { + "type": "doc", + "label": "from", + "id": "xstate.state.from" + }, + { + "type": "doc", + "label": "hasTag", + "id": "xstate.state.hastag" + }, + { + "type": "doc", + "label": "historyValue", + "id": "xstate.state.historyvalue" + }, + { + "type": "doc", + "label": "machine", + "id": "xstate.state.machine" + }, + { + "type": "doc", + "label": "matches", + "id": "xstate.state.matches" + }, + { + "type": "doc", + "label": "meta", + "id": "xstate.state.meta" + }, + { + "type": "doc", + "label": "nextEvents", + "id": "xstate.state.nextevents" + }, + { + "type": "doc", + "label": "status", + "id": "xstate.state.status" + }, + { + "type": "doc", + "label": "tags", + "id": "xstate.state.tags" + }, + { + "type": "doc", + "label": "toJSON", + "id": "xstate.state.tojson" + }, + { + "type": "doc", + "label": "toStrings", + "id": "xstate.state.tostrings" + }, + { + "type": "doc", + "label": "value", + "id": "xstate.state.value" + } + ] + }, { "type": "category", - "label": "XState API", + "label": "StateConfig", "link": { "type": "doc", - "id": "index" + "id": "xstate.stateconfig" }, "items": [ { "type": "doc", - "label": "__ResolvedTypesMetaFrom", - "id": "xstate.__resolvedtypesmetafrom" - }, - { - "type": "doc", - "label": "Action", - "id": "xstate.action" - }, - { - "type": "category", - "label": "ActionArgs", - "link": { - "type": "doc", - "id": "xstate.actionargs" - }, - "items": [ - { - "type": "doc", - "label": "action", - "id": "xstate.actionargs.action" - } - ] - }, - { - "type": "doc", - "label": "ActionFunction", - "id": "xstate.actionfunction" - }, - { - "type": "doc", - "label": "ActionFunctionMap", - "id": "xstate.actionfunctionmap" - }, - { - "type": "doc", - "label": "Actions", - "id": "xstate.actions" - }, - { - "type": "category", - "label": "Actor", - "link": { - "type": "doc", - "id": "xstate.actor" - }, - "items": [ - { - "type": "doc", - "label": "_parent", - "id": "xstate.actor._parent" - }, - { - "type": "doc", - "label": "[symbolObservable]", - "id": "xstate.actor._symbolobservable_" - }, - { - "type": "doc", - "label": "(constructor)", - "id": "xstate.actor._constructor_" - }, - { - "type": "doc", - "label": "cancel", - "id": "xstate.actor.cancel" - }, - { - "type": "doc", - "label": "clock", - "id": "xstate.actor.clock" - }, - { - "type": "doc", - "label": "delaySend", - "id": "xstate.actor.delaysend" - }, - { - "type": "doc", - "label": "getPersistedState", - "id": "xstate.actor.getpersistedstate" - }, - { - "type": "doc", - "label": "getSnapshot", - "id": "xstate.actor.getsnapshot" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.actor.id" - }, - { - "type": "doc", - "label": "logic", - "id": "xstate.actor.logic" - }, - { - "type": "doc", - "label": "options", - "id": "xstate.actor.options" - }, - { - "type": "doc", - "label": "ref", - "id": "xstate.actor.ref" - }, - { - "type": "doc", - "label": "send", - "id": "xstate.actor.send" - }, - { - "type": "doc", - "label": "sessionId", - "id": "xstate.actor.sessionid" - }, - { - "type": "doc", - "label": "src", - "id": "xstate.actor.src" - }, - { - "type": "doc", - "label": "start", - "id": "xstate.actor.start" - }, - { - "type": "doc", - "label": "status", - "id": "xstate.actor.status" - }, - { - "type": "doc", - "label": "stop", - "id": "xstate.actor.stop" - }, - { - "type": "doc", - "label": "subscribe", - "id": "xstate.actor.subscribe" - }, - { - "type": "doc", - "label": "subscribe", - "id": "xstate.actor.subscribe_1" - }, - { - "type": "doc", - "label": "system", - "id": "xstate.actor.system" - }, - { - "type": "doc", - "label": "toJSON", - "id": "xstate.actor.tojson" - } - ] - }, - { - "type": "category", - "label": "ActorContext", - "link": { - "type": "doc", - "id": "xstate.actorcontext" - }, - "items": [ - { - "type": "doc", - "label": "defer", - "id": "xstate.actorcontext.defer" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.actorcontext.id" - }, - { - "type": "doc", - "label": "logger", - "id": "xstate.actorcontext.logger" - }, - { - "type": "doc", - "label": "self", - "id": "xstate.actorcontext.self" - }, - { - "type": "doc", - "label": "sessionId", - "id": "xstate.actorcontext.sessionid" - }, - { - "type": "doc", - "label": "stopChild", - "id": "xstate.actorcontext.stopchild" - }, - { - "type": "doc", - "label": "system", - "id": "xstate.actorcontext.system" - } - ] - }, - { - "type": "category", - "label": "ActorLike", - "link": { - "type": "doc", - "id": "xstate.actorlike" - }, - "items": [ - { - "type": "doc", - "label": "send", - "id": "xstate.actorlike.send" - } - ] - }, - { - "type": "category", - "label": "ActorLogic", - "link": { - "type": "doc", - "id": "xstate.actorlogic" - }, - "items": [ - { - "type": "doc", - "label": "config", - "id": "xstate.actorlogic.config" - }, - { - "type": "doc", - "label": "getInitialState", - "id": "xstate.actorlogic.getinitialstate" - }, - { - "type": "doc", - "label": "getPersistedState", - "id": "xstate.actorlogic.getpersistedstate" - }, - { - "type": "doc", - "label": "restoreState", - "id": "xstate.actorlogic.restorestate" - }, - { - "type": "doc", - "label": "start", - "id": "xstate.actorlogic.start" - }, - { - "type": "doc", - "label": "transition", - "id": "xstate.actorlogic.transition" - } - ] - }, - { - "type": "doc", - "label": "ActorLogicFrom", - "id": "xstate.actorlogicfrom" - }, - { - "type": "category", - "label": "ActorOptions", - "link": { - "type": "doc", - "id": "xstate.actoroptions" - }, - "items": [ - { - "type": "doc", - "label": "clock", - "id": "xstate.actoroptions.clock" - }, - { - "type": "doc", - "label": "devTools", - "id": "xstate.actoroptions.devtools" - }, - { - "type": "doc", - "label": "execute", - "id": "xstate.actoroptions.execute" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.actoroptions.id" - }, - { - "type": "doc", - "label": "input", - "id": "xstate.actoroptions.input" - }, - { - "type": "doc", - "label": "inspect", - "id": "xstate.actoroptions.inspect" - }, - { - "type": "doc", - "label": "logger", - "id": "xstate.actoroptions.logger" - }, - { - "type": "doc", - "label": "parent", - "id": "xstate.actoroptions.parent" - }, - { - "type": "doc", - "label": "src", - "id": "xstate.actoroptions.src" - }, - { - "type": "doc", - "label": "state", - "id": "xstate.actoroptions.state" - }, - { - "type": "doc", - "label": "sync", - "id": "xstate.actoroptions.sync" - }, - { - "type": "doc", - "label": "systemId", - "id": "xstate.actoroptions.systemid" - } - ] - }, - { - "type": "category", - "label": "ActorRef", - "link": { - "type": "doc", - "id": "xstate.actorref" - }, - "items": [ - { - "type": "doc", - "label": "_parent", - "id": "xstate.actorref._parent" - }, - { - "type": "doc", - "label": "getPersistedState", - "id": "xstate.actorref.getpersistedstate" - }, - { - "type": "doc", - "label": "getSnapshot", - "id": "xstate.actorref.getsnapshot" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.actorref.id" - }, - { - "type": "doc", - "label": "send", - "id": "xstate.actorref.send" - }, - { - "type": "doc", - "label": "sessionId", - "id": "xstate.actorref.sessionid" - }, - { - "type": "doc", - "label": "src", - "id": "xstate.actorref.src" - }, - { - "type": "doc", - "label": "start", - "id": "xstate.actorref.start" - }, - { - "type": "doc", - "label": "status", - "id": "xstate.actorref.status" - }, - { - "type": "doc", - "label": "stop", - "id": "xstate.actorref.stop" - }, - { - "type": "doc", - "label": "system", - "id": "xstate.actorref.system" - }, - { - "type": "doc", - "label": "toJSON", - "id": "xstate.actorref.tojson" - } - ] - }, - { - "type": "doc", - "label": "ActorRefFrom", - "id": "xstate.actorreffrom" - }, + "label": "children", + "id": "xstate.stateconfig.children" + }, + { + "type": "doc", + "label": "configuration", + "id": "xstate.stateconfig.configuration" + }, + { + "type": "doc", + "label": "context", + "id": "xstate.stateconfig.context" + }, + { + "type": "doc", + "label": "error", + "id": "xstate.stateconfig.error" + }, + { + "type": "doc", + "label": "historyValue", + "id": "xstate.stateconfig.historyvalue" + }, { "type": "doc", - "label": "ActorStatus", - "id": "xstate.actorstatus" + "label": "machine", + "id": "xstate.stateconfig.machine" }, { - "type": "category", - "label": "ActorSystem", - "link": { - "type": "doc", - "id": "xstate.actorsystem" - }, - "items": [ - { - "type": "doc", - "label": "get", - "id": "xstate.actorsystem.get" - }, - { - "type": "doc", - "label": "inspect", - "id": "xstate.actorsystem.inspect" - } - ] + "type": "doc", + "label": "meta", + "id": "xstate.stateconfig.meta" }, { - "type": "category", - "label": "ActorSystemInfo", - "link": { - "type": "doc", - "id": "xstate.actorsysteminfo" - }, - "items": [ - { - "type": "doc", - "label": "actors", - "id": "xstate.actorsysteminfo.actors" - } - ] + "type": "doc", + "label": "output", + "id": "xstate.stateconfig.output" }, { "type": "doc", - "label": "and", - "id": "xstate.and" + "label": "status", + "id": "xstate.stateconfig.status" }, { "type": "doc", - "label": "AnyActor", - "id": "xstate.anyactor" + "label": "tags", + "id": "xstate.stateconfig.tags" }, { "type": "doc", - "label": "AnyActorContext", - "id": "xstate.anyactorcontext" + "label": "value", + "id": "xstate.stateconfig.value" + } + ] + }, + { + "type": "doc", + "label": "StateFrom", + "id": "xstate.statefrom" + }, + { + "type": "doc", + "label": "stateIn", + "id": "xstate.statein" + }, + { + "type": "doc", + "label": "StateKey", + "id": "xstate.statekey" + }, + { + "type": "category", + "label": "StateLike", + "link": { + "type": "doc", + "id": "xstate.statelike" + }, + "items": [ + { + "type": "doc", + "label": "context", + "id": "xstate.statelike.context" }, { "type": "doc", - "label": "AnyActorLogic", - "id": "xstate.anyactorlogic" + "label": "event", + "id": "xstate.statelike.event" }, { "type": "doc", - "label": "AnyActorRef", - "id": "xstate.anyactorref" + "label": "value", + "id": "xstate.statelike.value" + } + ] + }, + { + "type": "category", + "label": "StateMachine", + "link": { + "type": "doc", + "id": "xstate.statemachine" + }, + "items": [ + { + "type": "doc", + "label": "__TAction", + "id": "xstate.statemachine.__taction" }, { "type": "doc", - "label": "AnyActorSystem", - "id": "xstate.anyactorsystem" + "label": "__TActor", + "id": "xstate.statemachine.__tactor" }, { "type": "doc", - "label": "AnyEventObject", - "id": "xstate.anyeventobject" + "label": "__TContext", + "id": "xstate.statemachine.__tcontext" }, { "type": "doc", - "label": "AnyFunction", - "id": "xstate.anyfunction" + "label": "__TDelay", + "id": "xstate.statemachine.__tdelay" }, { "type": "doc", - "label": "AnyHistoryValue", - "id": "xstate.anyhistoryvalue" + "label": "__TEvent", + "id": "xstate.statemachine.__tevent" }, { "type": "doc", - "label": "AnyInterpreter", - "id": "xstate.anyinterpreter" + "label": "__TGuard", + "id": "xstate.statemachine.__tguard" }, { "type": "doc", - "label": "AnyInvokeConfig", - "id": "xstate.anyinvokeconfig" + "label": "__TInput", + "id": "xstate.statemachine.__tinput" }, { "type": "doc", - "label": "AnyState", - "id": "xstate.anystate" + "label": "__TOutput", + "id": "xstate.statemachine.__toutput" }, { "type": "doc", - "label": "AnyStateConfig", - "id": "xstate.anystateconfig" + "label": "__TResolvedTypesMeta", + "id": "xstate.statemachine.__tresolvedtypesmeta" }, { "type": "doc", - "label": "AnyStateMachine", - "id": "xstate.anystatemachine" + "label": "__TTag", + "id": "xstate.statemachine.__ttag" }, { "type": "doc", - "label": "AnyStateNode", - "id": "xstate.anystatenode" + "label": "__xstatenode", + "id": "xstate.statemachine.__xstatenode" }, { "type": "doc", - "label": "AnyStateNodeConfig", - "id": "xstate.anystatenodeconfig" + "label": "(constructor)", + "id": "xstate.statemachine._constructor_" }, { "type": "doc", - "label": "AnyStateNodeDefinition", - "id": "xstate.anystatenodedefinition" + "label": "config", + "id": "xstate.statemachine.config" }, { "type": "doc", - "label": "AnyTransitionConfig", - "id": "xstate.anytransitionconfig" + "label": "createState", + "id": "xstate.statemachine.createstate" }, { "type": "doc", - "label": "AnyTransitionDefinition", - "id": "xstate.anytransitiondefinition" + "label": "definition", + "id": "xstate.statemachine.definition" }, { "type": "doc", - "label": "AreAllImplementationsAssumedToBeProvided", - "id": "xstate.areallimplementationsassumedtobeprovided" + "label": "events", + "id": "xstate.statemachine.events" }, { "type": "doc", - "label": "assign", - "id": "xstate.assign" + "label": "getInitialState", + "id": "xstate.statemachine.getinitialstate" }, { - "type": "category", - "label": "AssignAction", - "link": { - "type": "doc", - "id": "xstate.assignaction" - }, - "items": [ - { - "type": "doc", - "label": "_out_TActor", - "id": "xstate.assignaction._out_tactor" - } - ] + "type": "doc", + "label": "getPersistedState", + "id": "xstate.statemachine.getpersistedstate" }, { - "type": "category", - "label": "AssignArgs", - "link": { - "type": "doc", - "id": "xstate.assignargs" - }, - "items": [ - { - "type": "doc", - "label": "spawn", - "id": "xstate.assignargs.spawn" - } - ] + "type": "doc", + "label": "getStateNodeById", + "id": "xstate.statemachine.getstatenodebyid" }, { "type": "doc", - "label": "Assigner", - "id": "xstate.assigner" + "label": "getTransitionData", + "id": "xstate.statemachine.gettransitiondata" }, { - "type": "category", - "label": "AtomicStateNodeConfig", - "link": { - "type": "doc", - "id": "xstate.atomicstatenodeconfig" - }, - "items": [ - { - "type": "doc", - "label": "initial", - "id": "xstate.atomicstatenodeconfig.initial" - }, - { - "type": "doc", - "label": "onDone", - "id": "xstate.atomicstatenodeconfig.ondone" - }, - { - "type": "doc", - "label": "parallel", - "id": "xstate.atomicstatenodeconfig.parallel" - }, - { - "type": "doc", - "label": "states", - "id": "xstate.atomicstatenodeconfig.states" - } - ] + "type": "doc", + "label": "id", + "id": "xstate.statemachine.id" }, { - "type": "category", - "label": "BaseActorRef", - "link": { - "type": "doc", - "id": "xstate.baseactorref" - }, - "items": [ - { - "type": "doc", - "label": "send", - "id": "xstate.baseactorref.send" - } - ] + "type": "doc", + "label": "idMap", + "id": "xstate.statemachine.idmap" }, { "type": "doc", - "label": "CallbackActorLogic", - "id": "xstate.callbackactorlogic" + "label": "implementations", + "id": "xstate.statemachine.implementations" }, { "type": "doc", - "label": "cancel", - "id": "xstate.cancel" + "label": "microstep", + "id": "xstate.statemachine.microstep" + }, + { + "type": "doc", + "label": "provide", + "id": "xstate.statemachine.provide" + }, + { + "type": "doc", + "label": "resolveState", + "id": "xstate.statemachine.resolvestate" }, { "type": "doc", - "label": "CancelAction", - "id": "xstate.cancelaction" + "label": "resolveStateValue", + "id": "xstate.statemachine.resolvestatevalue" }, { "type": "doc", - "label": "Cast", - "id": "xstate.cast" + "label": "restoreState", + "id": "xstate.statemachine.restorestate" }, { "type": "doc", - "label": "choose", - "id": "xstate.choose" + "label": "root", + "id": "xstate.statemachine.root" }, { - "type": "category", - "label": "ChooseAction", - "link": { - "type": "doc", - "id": "xstate.chooseaction" - }, - "items": [ - { - "type": "doc", - "label": "_out_TAction", - "id": "xstate.chooseaction._out_taction" - }, - { - "type": "doc", - "label": "_out_TActor", - "id": "xstate.chooseaction._out_tactor" - }, - { - "type": "doc", - "label": "_out_TDelay", - "id": "xstate.chooseaction._out_tdelay" - }, - { - "type": "doc", - "label": "_out_TGuard", - "id": "xstate.chooseaction._out_tguard" - } - ] + "type": "doc", + "label": "start", + "id": "xstate.statemachine.start" }, { - "type": "category", - "label": "ChooseBranch", - "link": { - "type": "doc", - "id": "xstate.choosebranch" - }, - "items": [ - { - "type": "doc", - "label": "actions", - "id": "xstate.choosebranch.actions" - }, - { - "type": "doc", - "label": "guard", - "id": "xstate.choosebranch.guard" - } - ] + "type": "doc", + "label": "states", + "id": "xstate.statemachine.states" }, { "type": "doc", - "label": "Compute", - "id": "xstate.compute" + "label": "toJSON", + "id": "xstate.statemachine.tojson" }, { "type": "doc", - "label": "ContextFactory", - "id": "xstate.contextfactory" + "label": "transition", + "id": "xstate.statemachine.transition" }, { "type": "doc", - "label": "ContextFrom", - "id": "xstate.contextfrom" + "label": "types", + "id": "xstate.statemachine.types" }, { "type": "doc", - "label": "createActor", - "id": "xstate.createactor" + "label": "version", + "id": "xstate.statemachine.version" + } + ] + }, + { + "type": "doc", + "label": "StateMachineDefinition", + "id": "xstate.statemachinedefinition" + }, + { + "type": "category", + "label": "StateNode", + "link": { + "type": "doc", + "id": "xstate.statenode" + }, + "items": [ + { + "type": "doc", + "label": "_initialize", + "id": "xstate.statenode._initialize" }, { "type": "doc", - "label": "createActor", - "id": "xstate.createactor_1" + "label": "(constructor)", + "id": "xstate.statenode._constructor_" }, { "type": "doc", - "label": "createEmptyActor", - "id": "xstate.createemptyactor" + "label": "after", + "id": "xstate.statenode.after" }, { "type": "doc", - "label": "createMachine", - "id": "xstate.createmachine" + "label": "always", + "id": "xstate.statenode.always" }, { "type": "doc", - "label": "DelayConfig", - "id": "xstate.delayconfig" + "label": "config", + "id": "xstate.statenode.config" }, { - "type": "category", - "label": "DelayedTransitionDefinition", - "link": { - "type": "doc", - "id": "xstate.delayedtransitiondefinition" - }, - "items": [ - { - "type": "doc", - "label": "delay", - "id": "xstate.delayedtransitiondefinition.delay" - } - ] + "type": "doc", + "label": "definition", + "id": "xstate.statenode.definition" }, { "type": "doc", - "label": "DelayedTransitions", - "id": "xstate.delayedtransitions" + "label": "description", + "id": "xstate.statenode.description" }, { "type": "doc", - "label": "DelayExpr", - "id": "xstate.delayexpr" + "label": "entry", + "id": "xstate.statenode.entry" }, { "type": "doc", - "label": "DelayFunctionMap", - "id": "xstate.delayfunctionmap" + "label": "events", + "id": "xstate.statenode.events" }, { "type": "doc", - "label": "DevToolsAdapter", - "id": "xstate.devtoolsadapter" + "label": "exit", + "id": "xstate.statenode.exit" }, { - "type": "category", - "label": "DoneActorEvent", - "link": { - "type": "doc", - "id": "xstate.doneactorevent" - }, - "items": [ - { - "type": "doc", - "label": "output", - "id": "xstate.doneactorevent.output" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.doneactorevent.type" - } - ] + "type": "doc", + "label": "history", + "id": "xstate.statenode.history" }, { - "type": "category", - "label": "DoneStateEvent", - "link": { - "type": "doc", - "id": "xstate.donestateevent" - }, - "items": [ - { - "type": "doc", - "label": "output", - "id": "xstate.donestateevent.output" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.donestateevent.type" - } - ] + "type": "doc", + "label": "id", + "id": "xstate.statenode.id" }, { "type": "doc", - "label": "Equals", - "id": "xstate.equals" + "label": "initial", + "id": "xstate.statenode.initial" }, { - "type": "category", - "label": "ErrorActorEvent", - "link": { - "type": "doc", - "id": "xstate.erroractorevent" - }, - "items": [ - { - "type": "doc", - "label": "data", - "id": "xstate.erroractorevent.data" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.erroractorevent.type" - } - ] + "type": "doc", + "label": "invoke", + "id": "xstate.statenode.invoke" }, { "type": "doc", - "label": "escalate", - "id": "xstate.escalate" + "label": "key", + "id": "xstate.statenode.key" }, { "type": "doc", - "label": "EventDescriptor", - "id": "xstate.eventdescriptor" + "label": "machine", + "id": "xstate.statenode.machine" }, { "type": "doc", - "label": "EventFrom", - "id": "xstate.eventfrom" + "label": "meta", + "id": "xstate.statenode.meta" }, { "type": "doc", - "label": "EventFromLogic", - "id": "xstate.eventfromlogic" + "label": "next", + "id": "xstate.statenode.next" }, { - "type": "category", - "label": "EventObject", - "link": { - "type": "doc", - "id": "xstate.eventobject" - }, - "items": [ - { - "type": "doc", - "label": "type", - "id": "xstate.eventobject.type" - } - ] + "type": "doc", + "label": "on", + "id": "xstate.statenode.on" }, { "type": "doc", - "label": "ExtractEvent", - "id": "xstate.extractevent" + "label": "order", + "id": "xstate.statenode.order" }, { "type": "doc", - "label": "forwardTo", - "id": "xstate.forwardto" + "label": "output", + "id": "xstate.statenode.output" }, { "type": "doc", - "label": "fromCallback", - "id": "xstate.fromcallback" + "label": "ownEvents", + "id": "xstate.statenode.ownevents" }, { "type": "doc", - "label": "fromEventObservable", - "id": "xstate.fromeventobservable" + "label": "parent", + "id": "xstate.statenode.parent" }, { "type": "doc", - "label": "fromObservable", - "id": "xstate.fromobservable" + "label": "path", + "id": "xstate.statenode.path" }, { "type": "doc", - "label": "fromPromise", - "id": "xstate.frompromise" + "label": "states", + "id": "xstate.statenode.states" }, { "type": "doc", - "label": "fromTransition", - "id": "xstate.fromtransition" + "label": "tags", + "id": "xstate.statenode.tags" }, { "type": "doc", - "label": "getStateNodes", - "id": "xstate.getstatenodes" + "label": "toJSON", + "id": "xstate.statenode.tojson" }, { - "type": "category", - "label": "HistoryStateNode", - "link": { - "type": "doc", - "id": "xstate.historystatenode" - }, - "items": [ - { - "type": "doc", - "label": "history", - "id": "xstate.historystatenode.history" - }, - { - "type": "doc", - "label": "target", - "id": "xstate.historystatenode.target" - } - ] + "type": "doc", + "label": "transitions", + "id": "xstate.statenode.transitions" }, { - "type": "category", - "label": "HistoryStateNodeConfig", - "link": { - "type": "doc", - "id": "xstate.historystatenodeconfig" - }, - "items": [ - { - "type": "doc", - "label": "history", - "id": "xstate.historystatenodeconfig.history" - }, - { - "type": "doc", - "label": "target", - "id": "xstate.historystatenodeconfig.target" - } - ] + "type": "doc", + "label": "type", + "id": "xstate.statenode.type" + } + ] + }, + { + "type": "category", + "label": "StateNodeConfig", + "link": { + "type": "doc", + "id": "xstate.statenodeconfig" + }, + "items": [ + { + "type": "doc", + "label": "after", + "id": "xstate.statenodeconfig.after" }, { "type": "doc", - "label": "HistoryValue", - "id": "xstate.historyvalue" + "label": "always", + "id": "xstate.statenodeconfig.always" }, { "type": "doc", - "label": "HomomorphicOmit", - "id": "xstate.homomorphicomit" + "label": "description", + "id": "xstate.statenodeconfig.description" }, { "type": "doc", - "label": "HomomorphicPick", - "id": "xstate.homomorphicpick" + "label": "entry", + "id": "xstate.statenodeconfig.entry" }, { "type": "doc", - "label": "IndexByProp", - "id": "xstate.indexbyprop" + "label": "exit", + "id": "xstate.statenodeconfig.exit" }, { "type": "doc", - "label": "IndexByType", - "id": "xstate.indexbytype" + "label": "history", + "id": "xstate.statenodeconfig.history" }, { "type": "doc", - "label": "InferEvent", - "id": "xstate.inferevent" - }, - { - "type": "category", - "label": "InitialTransitionConfig", - "link": { - "type": "doc", - "id": "xstate.initialtransitionconfig" - }, - "items": [ - { - "type": "doc", - "label": "target", - "id": "xstate.initialtransitionconfig.target" - } - ] - }, - { - "type": "category", - "label": "InitialTransitionDefinition", - "link": { - "type": "doc", - "id": "xstate.initialtransitiondefinition" - }, - "items": [ - { - "type": "doc", - "label": "guard", - "id": "xstate.initialtransitiondefinition.guard" - }, - { - "type": "doc", - "label": "target", - "id": "xstate.initialtransitiondefinition.target" - } - ] - }, - { - "type": "doc", - "label": "InputFrom", - "id": "xstate.inputfrom" - }, - { - "type": "category", - "label": "InspectedActorEvent", - "link": { - "type": "doc", - "id": "xstate.inspectedactorevent" - }, - "items": [ - { - "type": "doc", - "label": "actorRef", - "id": "xstate.inspectedactorevent.actorref" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.inspectedactorevent.type" - } - ] - }, - { - "type": "category", - "label": "InspectedEventEvent", - "link": { - "type": "doc", - "id": "xstate.inspectedeventevent" - }, - "items": [ - { - "type": "doc", - "label": "event", - "id": "xstate.inspectedeventevent.event" - }, - { - "type": "doc", - "label": "sourceRef", - "id": "xstate.inspectedeventevent.sourceref" - }, - { - "type": "doc", - "label": "targetRef", - "id": "xstate.inspectedeventevent.targetref" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.inspectedeventevent.type" - } - ] - }, - { - "type": "category", - "label": "InspectedSnapshotEvent", - "link": { - "type": "doc", - "id": "xstate.inspectedsnapshotevent" - }, - "items": [ - { - "type": "doc", - "label": "actorRef", - "id": "xstate.inspectedsnapshotevent.actorref" - }, - { - "type": "doc", - "label": "event", - "id": "xstate.inspectedsnapshotevent.event" - }, - { - "type": "doc", - "label": "snapshot", - "id": "xstate.inspectedsnapshotevent.snapshot" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.inspectedsnapshotevent.type" - } - ] - }, - { - "type": "doc", - "label": "InspectionEvent", - "id": "xstate.inspectionevent" - }, - { - "type": "doc", - "label": "InternalMachineImplementations", - "id": "xstate.internalmachineimplementations" - }, - { - "type": "category", - "label": "InteropObservable", - "link": { - "type": "doc", - "id": "xstate.interopobservable" - }, - "items": [ - { - "type": "doc", - "label": "[Symbol.observable]", - "id": "xstate.interopobservable._symbol.observable_" - } - ] - }, - { - "type": "category", - "label": "InteropSubscribable", - "link": { - "type": "doc", - "id": "xstate.interopsubscribable" - }, - "items": [ - { - "type": "doc", - "label": "subscribe", - "id": "xstate.interopsubscribable.subscribe" - } - ] - }, - { - "type": "doc", - "label": "interpret", - "id": "xstate.interpret" + "label": "id", + "id": "xstate.statenodeconfig.id" }, { "type": "doc", - "label": "Interpreter", - "id": "xstate.interpreter" + "label": "initial", + "id": "xstate.statenodeconfig.initial" }, { "type": "doc", - "label": "InterpreterFrom", - "id": "xstate.interpreterfrom" + "label": "invoke", + "id": "xstate.statenodeconfig.invoke" }, { "type": "doc", - "label": "InterpreterStatus", - "id": "xstate.interpreterstatus" + "label": "meta", + "id": "xstate.statenodeconfig.meta" }, { "type": "doc", - "label": "InvokeConfig", - "id": "xstate.invokeconfig" + "label": "on", + "id": "xstate.statenodeconfig.on" }, { - "type": "category", - "label": "InvokeDefinition", - "link": { - "type": "doc", - "id": "xstate.invokedefinition" - }, - "items": [ - { - "type": "doc", - "label": "id", - "id": "xstate.invokedefinition.id" - }, - { - "type": "doc", - "label": "input", - "id": "xstate.invokedefinition.input" - }, - { - "type": "doc", - "label": "onDone", - "id": "xstate.invokedefinition.ondone" - }, - { - "type": "doc", - "label": "onError", - "id": "xstate.invokedefinition.onerror" - }, - { - "type": "doc", - "label": "onSnapshot", - "id": "xstate.invokedefinition.onsnapshot" - }, - { - "type": "doc", - "label": "src", - "id": "xstate.invokedefinition.src" - }, - { - "type": "doc", - "label": "systemId", - "id": "xstate.invokedefinition.systemid" - }, - { - "type": "doc", - "label": "toJSON", - "id": "xstate.invokedefinition.tojson" - } - ] + "type": "doc", + "label": "onDone", + "id": "xstate.statenodeconfig.ondone" }, { "type": "doc", - "label": "IsAny", - "id": "xstate.isany" + "label": "order", + "id": "xstate.statenodeconfig.order" }, { "type": "doc", - "label": "IsLiteralString", - "id": "xstate.isliteralstring" + "label": "output", + "id": "xstate.statenodeconfig.output" }, { "type": "doc", - "label": "IsNever", - "id": "xstate.isnever" + "label": "states", + "id": "xstate.statenodeconfig.states" }, { "type": "doc", - "label": "Lazy", - "id": "xstate.lazy" + "label": "tags", + "id": "xstate.statenodeconfig.tags" }, { "type": "doc", - "label": "log", - "id": "xstate.log" + "label": "target", + "id": "xstate.statenodeconfig.target" }, { "type": "doc", - "label": "LogAction", - "id": "xstate.logaction" + "label": "type", + "id": "xstate.statenodeconfig.type" + } + ] + }, + { + "type": "category", + "label": "StateNodeDefinition", + "link": { + "type": "doc", + "id": "xstate.statenodedefinition" + }, + "items": [ + { + "type": "doc", + "label": "description", + "id": "xstate.statenodedefinition.description" }, { "type": "doc", - "label": "LogExpr", - "id": "xstate.logexpr" + "label": "entry", + "id": "xstate.statenodedefinition.entry" }, { "type": "doc", - "label": "LowInfer", - "id": "xstate.lowinfer" + "label": "exit", + "id": "xstate.statenodedefinition.exit" }, { - "type": "doc", - "label": "MachineConfig", - "id": "xstate.machineconfig" - }, - { - "type": "doc", - "label": "MachineContext", - "id": "xstate.machinecontext" - }, - { - "type": "doc", - "label": "MachineImplementations", - "id": "xstate.machineimplementations" - }, - { - "type": "doc", - "label": "MachineImplementationsFrom", - "id": "xstate.machineimplementationsfrom" - }, - { - "type": "category", - "label": "MachineImplementationsSimplified", - "link": { - "type": "doc", - "id": "xstate.machineimplementationssimplified" - }, - "items": [ - { - "type": "doc", - "label": "actions", - "id": "xstate.machineimplementationssimplified.actions" - }, - { - "type": "doc", - "label": "actors", - "id": "xstate.machineimplementationssimplified.actors" - }, - { - "type": "doc", - "label": "delays", - "id": "xstate.machineimplementationssimplified.delays" - }, - { - "type": "doc", - "label": "guards", - "id": "xstate.machineimplementationssimplified.guards" - } - ] + "type": "doc", + "label": "history", + "id": "xstate.statenodedefinition.history" }, { "type": "doc", - "label": "MachineSnapshot", - "id": "xstate.machinesnapshot" + "label": "id", + "id": "xstate.statenodedefinition.id" }, { - "type": "category", - "label": "MachineTypes", - "link": { - "type": "doc", - "id": "xstate.machinetypes" - }, - "items": [ - { - "type": "doc", - "label": "actions", - "id": "xstate.machinetypes.actions" - }, - { - "type": "doc", - "label": "actors", - "id": "xstate.machinetypes.actors" - }, - { - "type": "doc", - "label": "context", - "id": "xstate.machinetypes.context" - }, - { - "type": "doc", - "label": "delays", - "id": "xstate.machinetypes.delays" - }, - { - "type": "doc", - "label": "events", - "id": "xstate.machinetypes.events" - }, - { - "type": "doc", - "label": "guards", - "id": "xstate.machinetypes.guards" - }, - { - "type": "doc", - "label": "input", - "id": "xstate.machinetypes.input" - }, - { - "type": "doc", - "label": "output", - "id": "xstate.machinetypes.output" - }, - { - "type": "doc", - "label": "tags", - "id": "xstate.machinetypes.tags" - }, - { - "type": "doc", - "label": "typegen", - "id": "xstate.machinetypes.typegen" - } - ] + "type": "doc", + "label": "initial", + "id": "xstate.statenodedefinition.initial" }, { "type": "doc", - "label": "Mapper", - "id": "xstate.mapper" + "label": "invoke", + "id": "xstate.statenodedefinition.invoke" }, { "type": "doc", - "label": "mapState", - "id": "xstate.mapstate" + "label": "key", + "id": "xstate.statenodedefinition.key" }, { - "type": "category", - "label": "MarkAllImplementationsAsProvided", - "link": { - "type": "doc", - "id": "xstate.markallimplementationsasprovided" - }, - "items": [ - { - "type": "doc", - "label": "\"@@xstate/typegen\"", - "id": "xstate.markallimplementationsasprovided.___xstate_typegen_" - }, - { - "type": "doc", - "label": "resolved", - "id": "xstate.markallimplementationsasprovided.resolved" - } - ] + "type": "doc", + "label": "meta", + "id": "xstate.statenodedefinition.meta" }, { "type": "doc", - "label": "matchesState", - "id": "xstate.matchesstate" + "label": "on", + "id": "xstate.statenodedefinition.on" }, { "type": "doc", - "label": "MaybeLazy", - "id": "xstate.maybelazy" + "label": "order", + "id": "xstate.statenodedefinition.order" }, { "type": "doc", - "label": "Merge", - "id": "xstate.merge" + "label": "output", + "id": "xstate.statenodedefinition.output" }, { "type": "doc", - "label": "MetaObject", - "id": "xstate.metaobject" + "label": "states", + "id": "xstate.statenodedefinition.states" }, { "type": "doc", - "label": "MissingImplementationsError", - "id": "xstate.missingimplementationserror" + "label": "tags", + "id": "xstate.statenodedefinition.tags" }, { "type": "doc", - "label": "NoInfer", - "id": "xstate.noinfer" + "label": "transitions", + "id": "xstate.statenodedefinition.transitions" }, { "type": "doc", - "label": "NonReducibleUnknown", - "id": "xstate.nonreducibleunknown" + "label": "type", + "id": "xstate.statenodedefinition.type" }, { "type": "doc", - "label": "NoRequiredParams", - "id": "xstate.norequiredparams" + "label": "version", + "id": "xstate.statenodedefinition.version" + } + ] + }, + { + "type": "doc", + "label": "StateNodesConfig", + "id": "xstate.statenodesconfig" + }, + { + "type": "doc", + "label": "StatesConfig", + "id": "xstate.statesconfig" + }, + { + "type": "doc", + "label": "StatesDefinition", + "id": "xstate.statesdefinition" + }, + { + "type": "doc", + "label": "StateTypes", + "id": "xstate.statetypes" + }, + { + "type": "doc", + "label": "StateValue", + "id": "xstate.statevalue" + }, + { + "type": "doc", + "label": "StateValueFrom", + "id": "xstate.statevaluefrom" + }, + { + "type": "doc", + "label": "StateValueMap", + "id": "xstate.statevaluemap" + }, + { + "type": "doc", + "label": "stop_2", + "id": "xstate.stop_2" + }, + { + "type": "doc", + "label": "StopAction", + "id": "xstate.stopaction" + }, + { + "type": "category", + "label": "Subscribable", + "link": { + "type": "doc", + "id": "xstate.subscribable" + }, + "items": [ + { + "type": "doc", + "label": "subscribe", + "id": "xstate.subscribable.subscribe" }, { "type": "doc", - "label": "not", - "id": "xstate.not" + "label": "subscribe", + "id": "xstate.subscribable.subscribe_1" + } + ] + }, + { + "type": "category", + "label": "Subscription", + "link": { + "type": "doc", + "id": "xstate.subscription" + }, + "items": [ + { + "type": "doc", + "label": "unsubscribe", + "id": "xstate.subscription.unsubscribe" + } + ] + }, + { + "type": "doc", + "label": "TagsFrom", + "id": "xstate.tagsfrom" + }, + { + "type": "doc", + "label": "TODO", + "id": "xstate.todo" + }, + { + "type": "doc", + "label": "toObserver", + "id": "xstate.toobserver" + }, + { + "type": "doc", + "label": "TransitionActorLogic", + "id": "xstate.transitionactorlogic" + }, + { + "type": "category", + "label": "TransitionConfig", + "link": { + "type": "doc", + "id": "xstate.transitionconfig" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.transitionconfig.actions" }, { "type": "doc", - "label": "ObservableActorLogic", - "id": "xstate.observableactorlogic" + "label": "description", + "id": "xstate.transitionconfig.description" }, { "type": "doc", - "label": "Observer", - "id": "xstate.observer" + "label": "guard", + "id": "xstate.transitionconfig.guard" }, { "type": "doc", - "label": "or", - "id": "xstate.or" + "label": "meta", + "id": "xstate.transitionconfig.meta" }, { "type": "doc", - "label": "OutputFrom", - "id": "xstate.outputfrom" + "label": "reenter", + "id": "xstate.transitionconfig.reenter" }, { - "type": "category", - "label": "ParameterizedObject", - "link": { - "type": "doc", - "id": "xstate.parameterizedobject" - }, - "items": [ - { - "type": "doc", - "label": "params", - "id": "xstate.parameterizedobject.params" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.parameterizedobject.type" - } - ] + "type": "doc", + "label": "target", + "id": "xstate.transitionconfig.target" + } + ] + }, + { + "type": "doc", + "label": "TransitionConfigOrTarget", + "id": "xstate.transitionconfigortarget" + }, + { + "type": "doc", + "label": "TransitionConfigTarget", + "id": "xstate.transitionconfigtarget" + }, + { + "type": "category", + "label": "TransitionDefinition", + "link": { + "type": "doc", + "id": "xstate.transitiondefinition" + }, + "items": [ + { + "type": "doc", + "label": "actions", + "id": "xstate.transitiondefinition.actions" }, { "type": "doc", - "label": "PartialAssigner", - "id": "xstate.partialassigner" + "label": "eventType", + "id": "xstate.transitiondefinition.eventtype" }, { "type": "doc", - "label": "pathToStateValue", - "id": "xstate.pathtostatevalue" + "label": "guard", + "id": "xstate.transitiondefinition.guard" }, { "type": "doc", - "label": "PersistedMachineState", - "id": "xstate.persistedmachinestate" + "label": "reenter", + "id": "xstate.transitiondefinition.reenter" }, { "type": "doc", - "label": "PersistedStateFrom", - "id": "xstate.persistedstatefrom" + "label": "source", + "id": "xstate.transitiondefinition.source" }, { "type": "doc", - "label": "PromiseActorLogic", - "id": "xstate.promiseactorlogic" + "label": "target", + "id": "xstate.transitiondefinition.target" }, { "type": "doc", - "label": "Prop", - "id": "xstate.prop" + "label": "toJSON", + "id": "xstate.transitiondefinition.tojson" + } + ] + }, + { + "type": "doc", + "label": "TransitionDefinitionMap", + "id": "xstate.transitiondefinitionmap" + }, + { + "type": "doc", + "label": "Transitions", + "id": "xstate.transitions" + }, + { + "type": "doc", + "label": "TransitionsConfig", + "id": "xstate.transitionsconfig" + }, + { + "type": "doc", + "label": "TransitionSnapshot", + "id": "xstate.transitionsnapshot" + }, + { + "type": "doc", + "label": "TransitionTarget", + "id": "xstate.transitiontarget" + }, + { + "type": "doc", + "label": "TypegenConstraint", + "id": "xstate.typegenconstraint" + }, + { + "type": "category", + "label": "TypegenDisabled", + "link": { + "type": "doc", + "id": "xstate.typegendisabled" + }, + "items": [ + { + "type": "doc", + "label": "\"@@xstate/typegen\"", + "id": "xstate.typegendisabled.___xstate_typegen_" + } + ] + }, + { + "type": "category", + "label": "TypegenEnabled", + "link": { + "type": "doc", + "id": "xstate.typegenenabled" + }, + "items": [ + { + "type": "doc", + "label": "\"@@xstate/typegen\"", + "id": "xstate.typegenenabled.___xstate_typegen_" + } + ] + }, + { + "type": "category", + "label": "TypegenMeta", + "link": { + "type": "doc", + "id": "xstate.typegenmeta" + }, + "items": [ + { + "type": "doc", + "label": "eventsCausingActions", + "id": "xstate.typegenmeta.eventscausingactions" }, { "type": "doc", - "label": "PropertyAssigner", - "id": "xstate.propertyassigner" + "label": "eventsCausingActors", + "id": "xstate.typegenmeta.eventscausingactors" }, { - "type": "category", - "label": "ProvidedActor", - "link": { - "type": "doc", - "id": "xstate.providedactor" - }, - "items": [ - { - "type": "doc", - "label": "id", - "id": "xstate.providedactor.id" - }, - { - "type": "doc", - "label": "logic", - "id": "xstate.providedactor.logic" - }, - { - "type": "doc", - "label": "src", - "id": "xstate.providedactor.src" - } - ] + "type": "doc", + "label": "eventsCausingDelays", + "id": "xstate.typegenmeta.eventscausingdelays" }, { "type": "doc", - "label": "pure", - "id": "xstate.pure" - }, - { - "type": "category", - "label": "PureAction", - "link": { - "type": "doc", - "id": "xstate.pureaction" - }, - "items": [ - { - "type": "doc", - "label": "_out_TAction", - "id": "xstate.pureaction._out_taction" - }, - { - "type": "doc", - "label": "_out_TActor", - "id": "xstate.pureaction._out_tactor" - }, - { - "type": "doc", - "label": "_out_TDelay", - "id": "xstate.pureaction._out_tdelay" - }, - { - "type": "doc", - "label": "_out_TEvent", - "id": "xstate.pureaction._out_tevent" - }, - { - "type": "doc", - "label": "_out_TGuard", - "id": "xstate.pureaction._out_tguard" - } - ] - }, - { - "type": "doc", - "label": "raise", - "id": "xstate.raise" - }, - { - "type": "category", - "label": "RaiseAction", - "link": { - "type": "doc", - "id": "xstate.raiseaction" - }, - "items": [ - { - "type": "doc", - "label": "_out_TDelay", - "id": "xstate.raiseaction._out_tdelay" - }, - { - "type": "doc", - "label": "_out_TEvent", - "id": "xstate.raiseaction._out_tevent" - } - ] - }, - { - "type": "category", - "label": "RaiseActionOptions", - "link": { - "type": "doc", - "id": "xstate.raiseactionoptions" - }, - "items": [ - { - "type": "doc", - "label": "delay", - "id": "xstate.raiseactionoptions.delay" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.raiseactionoptions.id" - } - ] - }, - { - "type": "category", - "label": "RaiseActionParams", - "link": { - "type": "doc", - "id": "xstate.raiseactionparams" - }, - "items": [ - { - "type": "doc", - "label": "event", - "id": "xstate.raiseactionparams.event" - } - ] - }, - { - "type": "category", - "label": "ResolvedTypegenMeta", - "link": { - "type": "doc", - "id": "xstate.resolvedtypegenmeta" - }, - "items": [ - { - "type": "doc", - "label": "resolved", - "id": "xstate.resolvedtypegenmeta.resolved" - } - ] - }, - { - "type": "category", - "label": "ResolveTypegenMeta", - "link": { - "type": "doc", - "id": "xstate.resolvetypegenmeta" - }, - "items": [ - { - "type": "doc", - "label": "\"@@xstate/typegen\"", - "id": "xstate.resolvetypegenmeta.___xstate_typegen_" - }, - { - "type": "doc", - "label": "resolved", - "id": "xstate.resolvetypegenmeta.resolved" - } - ] - }, - { - "type": "doc", - "label": "SendExpr", - "id": "xstate.sendexpr" - }, - { - "type": "doc", - "label": "sendParent", - "id": "xstate.sendparent" - }, - { - "type": "doc", - "label": "sendTo", - "id": "xstate.sendto" - }, - { - "type": "category", - "label": "SendToAction", - "link": { - "type": "doc", - "id": "xstate.sendtoaction" - }, - "items": [ - { - "type": "doc", - "label": "_out_TDelay", - "id": "xstate.sendtoaction._out_tdelay" - } - ] - }, - { - "type": "doc", - "label": "SendToActionOptions", - "id": "xstate.sendtoactionoptions" - }, - { - "type": "category", - "label": "SendToActionParams", - "link": { - "type": "doc", - "id": "xstate.sendtoactionparams" - }, - "items": [ - { - "type": "doc", - "label": "event", - "id": "xstate.sendtoactionparams.event" - } - ] - }, - { - "type": "doc", - "label": "SimpleOrStateNodeConfig", - "id": "xstate.simpleorstatenodeconfig" - }, - { - "type": "category", - "label": "SimulatedClock", - "link": { - "type": "doc", - "id": "xstate.simulatedclock" - }, - "items": [ - { - "type": "doc", - "label": "clearTimeout", - "id": "xstate.simulatedclock.cleartimeout" - }, - { - "type": "doc", - "label": "now", - "id": "xstate.simulatedclock.now" - }, - { - "type": "doc", - "label": "setTimeout", - "id": "xstate.simulatedclock.settimeout" - } - ] - }, - { - "type": "category", - "label": "SimulatedClock", - "link": { - "type": "doc", - "id": "xstate.simulatedclock" - }, - "items": [ - { - "type": "doc", - "label": "increment", - "id": "xstate.simulatedclock.increment" - }, - { - "type": "doc", - "label": "set", - "id": "xstate.simulatedclock.set" - }, - { - "type": "doc", - "label": "start", - "id": "xstate.simulatedclock.start" - } - ] - }, - { - "type": "doc", - "label": "SingleOrArray", - "id": "xstate.singleorarray" - }, - { - "type": "doc", - "label": "Snapshot", - "id": "xstate.snapshot" - }, - { - "type": "category", - "label": "SnapshotEvent", - "link": { - "type": "doc", - "id": "xstate.snapshotevent" - }, - "items": [ - { - "type": "doc", - "label": "snapshot", - "id": "xstate.snapshotevent.snapshot" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.snapshotevent.type" - } - ] - }, - { - "type": "doc", - "label": "SnapshotFrom", - "id": "xstate.snapshotfrom" - }, - { - "type": "doc", - "label": "Spawner", - "id": "xstate.spawner" - }, - { - "type": "doc", - "label": "SpecialTargets", - "id": "xstate.specialtargets" - }, - { - "type": "category", - "label": "State", - "link": { - "type": "doc", - "id": "xstate.state" - }, - "items": [ - { - "type": "doc", - "label": "(constructor)", - "id": "xstate.state._constructor_" - }, - { - "type": "doc", - "label": "can", - "id": "xstate.state.can" - }, - { - "type": "doc", - "label": "children", - "id": "xstate.state.children" - }, - { - "type": "doc", - "label": "configuration", - "id": "xstate.state.configuration" - }, - { - "type": "doc", - "label": "context", - "id": "xstate.state.context" - }, - { - "type": "doc", - "label": "error", - "id": "xstate.state.error" - }, - { - "type": "doc", - "label": "from", - "id": "xstate.state.from" - }, - { - "type": "doc", - "label": "hasTag", - "id": "xstate.state.hastag" - }, - { - "type": "doc", - "label": "historyValue", - "id": "xstate.state.historyvalue" - }, - { - "type": "doc", - "label": "machine", - "id": "xstate.state.machine" - }, - { - "type": "doc", - "label": "matches", - "id": "xstate.state.matches" - }, - { - "type": "doc", - "label": "meta", - "id": "xstate.state.meta" - }, - { - "type": "doc", - "label": "nextEvents", - "id": "xstate.state.nextevents" - }, - { - "type": "doc", - "label": "status", - "id": "xstate.state.status" - }, - { - "type": "doc", - "label": "tags", - "id": "xstate.state.tags" - }, - { - "type": "doc", - "label": "toJSON", - "id": "xstate.state.tojson" - }, - { - "type": "doc", - "label": "toStrings", - "id": "xstate.state.tostrings" - }, - { - "type": "doc", - "label": "value", - "id": "xstate.state.value" - } - ] - }, - { - "type": "category", - "label": "StateConfig", - "link": { - "type": "doc", - "id": "xstate.stateconfig" - }, - "items": [ - { - "type": "doc", - "label": "children", - "id": "xstate.stateconfig.children" - }, - { - "type": "doc", - "label": "configuration", - "id": "xstate.stateconfig.configuration" - }, - { - "type": "doc", - "label": "context", - "id": "xstate.stateconfig.context" - }, - { - "type": "doc", - "label": "error", - "id": "xstate.stateconfig.error" - }, - { - "type": "doc", - "label": "historyValue", - "id": "xstate.stateconfig.historyvalue" - }, - { - "type": "doc", - "label": "machine", - "id": "xstate.stateconfig.machine" - }, - { - "type": "doc", - "label": "meta", - "id": "xstate.stateconfig.meta" - }, - { - "type": "doc", - "label": "output", - "id": "xstate.stateconfig.output" - }, - { - "type": "doc", - "label": "status", - "id": "xstate.stateconfig.status" - }, - { - "type": "doc", - "label": "tags", - "id": "xstate.stateconfig.tags" - }, - { - "type": "doc", - "label": "value", - "id": "xstate.stateconfig.value" - } - ] - }, - { - "type": "doc", - "label": "StateFrom", - "id": "xstate.statefrom" - }, - { - "type": "doc", - "label": "stateIn", - "id": "xstate.statein" - }, - { - "type": "doc", - "label": "StateKey", - "id": "xstate.statekey" - }, - { - "type": "category", - "label": "StateLike", - "link": { - "type": "doc", - "id": "xstate.statelike" - }, - "items": [ - { - "type": "doc", - "label": "context", - "id": "xstate.statelike.context" - }, - { - "type": "doc", - "label": "event", - "id": "xstate.statelike.event" - }, - { - "type": "doc", - "label": "value", - "id": "xstate.statelike.value" - } - ] - }, - { - "type": "category", - "label": "StateMachine", - "link": { - "type": "doc", - "id": "xstate.statemachine" - }, - "items": [ - { - "type": "doc", - "label": "__TAction", - "id": "xstate.statemachine.__taction" - }, - { - "type": "doc", - "label": "__TActor", - "id": "xstate.statemachine.__tactor" - }, - { - "type": "doc", - "label": "__TContext", - "id": "xstate.statemachine.__tcontext" - }, - { - "type": "doc", - "label": "__TDelay", - "id": "xstate.statemachine.__tdelay" - }, - { - "type": "doc", - "label": "__TEvent", - "id": "xstate.statemachine.__tevent" - }, - { - "type": "doc", - "label": "__TGuard", - "id": "xstate.statemachine.__tguard" - }, - { - "type": "doc", - "label": "__TInput", - "id": "xstate.statemachine.__tinput" - }, - { - "type": "doc", - "label": "__TOutput", - "id": "xstate.statemachine.__toutput" - }, - { - "type": "doc", - "label": "__TResolvedTypesMeta", - "id": "xstate.statemachine.__tresolvedtypesmeta" - }, - { - "type": "doc", - "label": "__TTag", - "id": "xstate.statemachine.__ttag" - }, - { - "type": "doc", - "label": "__xstatenode", - "id": "xstate.statemachine.__xstatenode" - }, - { - "type": "doc", - "label": "(constructor)", - "id": "xstate.statemachine._constructor_" - }, - { - "type": "doc", - "label": "config", - "id": "xstate.statemachine.config" - }, - { - "type": "doc", - "label": "createState", - "id": "xstate.statemachine.createstate" - }, - { - "type": "doc", - "label": "definition", - "id": "xstate.statemachine.definition" - }, - { - "type": "doc", - "label": "events", - "id": "xstate.statemachine.events" - }, - { - "type": "doc", - "label": "getInitialState", - "id": "xstate.statemachine.getinitialstate" - }, - { - "type": "doc", - "label": "getPersistedState", - "id": "xstate.statemachine.getpersistedstate" - }, - { - "type": "doc", - "label": "getStateNodeById", - "id": "xstate.statemachine.getstatenodebyid" - }, - { - "type": "doc", - "label": "getTransitionData", - "id": "xstate.statemachine.gettransitiondata" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.statemachine.id" - }, - { - "type": "doc", - "label": "idMap", - "id": "xstate.statemachine.idmap" - }, - { - "type": "doc", - "label": "implementations", - "id": "xstate.statemachine.implementations" - }, - { - "type": "doc", - "label": "microstep", - "id": "xstate.statemachine.microstep" - }, - { - "type": "doc", - "label": "provide", - "id": "xstate.statemachine.provide" - }, - { - "type": "doc", - "label": "resolveState", - "id": "xstate.statemachine.resolvestate" - }, - { - "type": "doc", - "label": "resolveStateValue", - "id": "xstate.statemachine.resolvestatevalue" - }, - { - "type": "doc", - "label": "restoreState", - "id": "xstate.statemachine.restorestate" - }, - { - "type": "doc", - "label": "root", - "id": "xstate.statemachine.root" - }, - { - "type": "doc", - "label": "start", - "id": "xstate.statemachine.start" - }, - { - "type": "doc", - "label": "states", - "id": "xstate.statemachine.states" - }, - { - "type": "doc", - "label": "toJSON", - "id": "xstate.statemachine.tojson" - }, - { - "type": "doc", - "label": "transition", - "id": "xstate.statemachine.transition" - }, - { - "type": "doc", - "label": "types", - "id": "xstate.statemachine.types" - }, - { - "type": "doc", - "label": "version", - "id": "xstate.statemachine.version" - } - ] - }, - { - "type": "doc", - "label": "StateMachineDefinition", - "id": "xstate.statemachinedefinition" - }, - { - "type": "category", - "label": "StateNode", - "link": { - "type": "doc", - "id": "xstate.statenode" - }, - "items": [ - { - "type": "doc", - "label": "_initialize", - "id": "xstate.statenode._initialize" - }, - { - "type": "doc", - "label": "(constructor)", - "id": "xstate.statenode._constructor_" - }, - { - "type": "doc", - "label": "after", - "id": "xstate.statenode.after" - }, - { - "type": "doc", - "label": "always", - "id": "xstate.statenode.always" - }, - { - "type": "doc", - "label": "config", - "id": "xstate.statenode.config" - }, - { - "type": "doc", - "label": "definition", - "id": "xstate.statenode.definition" - }, - { - "type": "doc", - "label": "description", - "id": "xstate.statenode.description" - }, - { - "type": "doc", - "label": "entry", - "id": "xstate.statenode.entry" - }, - { - "type": "doc", - "label": "events", - "id": "xstate.statenode.events" - }, - { - "type": "doc", - "label": "exit", - "id": "xstate.statenode.exit" - }, - { - "type": "doc", - "label": "history", - "id": "xstate.statenode.history" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.statenode.id" - }, - { - "type": "doc", - "label": "initial", - "id": "xstate.statenode.initial" - }, - { - "type": "doc", - "label": "invoke", - "id": "xstate.statenode.invoke" - }, - { - "type": "doc", - "label": "key", - "id": "xstate.statenode.key" - }, - { - "type": "doc", - "label": "machine", - "id": "xstate.statenode.machine" - }, - { - "type": "doc", - "label": "meta", - "id": "xstate.statenode.meta" - }, - { - "type": "doc", - "label": "next", - "id": "xstate.statenode.next" - }, - { - "type": "doc", - "label": "on", - "id": "xstate.statenode.on" - }, - { - "type": "doc", - "label": "order", - "id": "xstate.statenode.order" - }, - { - "type": "doc", - "label": "output", - "id": "xstate.statenode.output" - }, - { - "type": "doc", - "label": "ownEvents", - "id": "xstate.statenode.ownevents" - }, - { - "type": "doc", - "label": "parent", - "id": "xstate.statenode.parent" - }, - { - "type": "doc", - "label": "path", - "id": "xstate.statenode.path" - }, - { - "type": "doc", - "label": "states", - "id": "xstate.statenode.states" - }, - { - "type": "doc", - "label": "tags", - "id": "xstate.statenode.tags" - }, - { - "type": "doc", - "label": "toJSON", - "id": "xstate.statenode.tojson" - }, - { - "type": "doc", - "label": "transitions", - "id": "xstate.statenode.transitions" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.statenode.type" - } - ] - }, - { - "type": "category", - "label": "StateNodeConfig", - "link": { - "type": "doc", - "id": "xstate.statenodeconfig" - }, - "items": [ - { - "type": "doc", - "label": "after", - "id": "xstate.statenodeconfig.after" - }, - { - "type": "doc", - "label": "always", - "id": "xstate.statenodeconfig.always" - }, - { - "type": "doc", - "label": "description", - "id": "xstate.statenodeconfig.description" - }, - { - "type": "doc", - "label": "entry", - "id": "xstate.statenodeconfig.entry" - }, - { - "type": "doc", - "label": "exit", - "id": "xstate.statenodeconfig.exit" - }, - { - "type": "doc", - "label": "history", - "id": "xstate.statenodeconfig.history" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.statenodeconfig.id" - }, - { - "type": "doc", - "label": "initial", - "id": "xstate.statenodeconfig.initial" - }, - { - "type": "doc", - "label": "invoke", - "id": "xstate.statenodeconfig.invoke" - }, - { - "type": "doc", - "label": "meta", - "id": "xstate.statenodeconfig.meta" - }, - { - "type": "doc", - "label": "on", - "id": "xstate.statenodeconfig.on" - }, - { - "type": "doc", - "label": "onDone", - "id": "xstate.statenodeconfig.ondone" - }, - { - "type": "doc", - "label": "order", - "id": "xstate.statenodeconfig.order" - }, - { - "type": "doc", - "label": "output", - "id": "xstate.statenodeconfig.output" - }, - { - "type": "doc", - "label": "states", - "id": "xstate.statenodeconfig.states" - }, - { - "type": "doc", - "label": "tags", - "id": "xstate.statenodeconfig.tags" - }, - { - "type": "doc", - "label": "target", - "id": "xstate.statenodeconfig.target" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.statenodeconfig.type" - } - ] - }, - { - "type": "category", - "label": "StateNodeDefinition", - "link": { - "type": "doc", - "id": "xstate.statenodedefinition" - }, - "items": [ - { - "type": "doc", - "label": "description", - "id": "xstate.statenodedefinition.description" - }, - { - "type": "doc", - "label": "entry", - "id": "xstate.statenodedefinition.entry" - }, - { - "type": "doc", - "label": "exit", - "id": "xstate.statenodedefinition.exit" - }, - { - "type": "doc", - "label": "history", - "id": "xstate.statenodedefinition.history" - }, - { - "type": "doc", - "label": "id", - "id": "xstate.statenodedefinition.id" - }, - { - "type": "doc", - "label": "initial", - "id": "xstate.statenodedefinition.initial" - }, - { - "type": "doc", - "label": "invoke", - "id": "xstate.statenodedefinition.invoke" - }, - { - "type": "doc", - "label": "key", - "id": "xstate.statenodedefinition.key" - }, - { - "type": "doc", - "label": "meta", - "id": "xstate.statenodedefinition.meta" - }, - { - "type": "doc", - "label": "on", - "id": "xstate.statenodedefinition.on" - }, - { - "type": "doc", - "label": "order", - "id": "xstate.statenodedefinition.order" - }, - { - "type": "doc", - "label": "output", - "id": "xstate.statenodedefinition.output" - }, - { - "type": "doc", - "label": "states", - "id": "xstate.statenodedefinition.states" - }, - { - "type": "doc", - "label": "tags", - "id": "xstate.statenodedefinition.tags" - }, - { - "type": "doc", - "label": "transitions", - "id": "xstate.statenodedefinition.transitions" - }, - { - "type": "doc", - "label": "type", - "id": "xstate.statenodedefinition.type" - }, - { - "type": "doc", - "label": "version", - "id": "xstate.statenodedefinition.version" - } - ] - }, - { - "type": "doc", - "label": "StateNodesConfig", - "id": "xstate.statenodesconfig" - }, - { - "type": "doc", - "label": "StatesConfig", - "id": "xstate.statesconfig" - }, - { - "type": "doc", - "label": "StatesDefinition", - "id": "xstate.statesdefinition" - }, - { - "type": "doc", - "label": "StateTypes", - "id": "xstate.statetypes" - }, - { - "type": "doc", - "label": "StateValue", - "id": "xstate.statevalue" - }, - { - "type": "doc", - "label": "StateValueFrom", - "id": "xstate.statevaluefrom" - }, - { - "type": "doc", - "label": "StateValueMap", - "id": "xstate.statevaluemap" - }, - { - "type": "doc", - "label": "stop_2", - "id": "xstate.stop_2" - }, - { - "type": "doc", - "label": "StopAction", - "id": "xstate.stopaction" + "label": "eventsCausingGuards", + "id": "xstate.typegenmeta.eventscausingguards" }, { - "type": "category", - "label": "Subscribable", - "link": { - "type": "doc", - "id": "xstate.subscribable" - }, - "items": [ - { - "type": "doc", - "label": "subscribe", - "id": "xstate.subscribable.subscribe" - }, - { - "type": "doc", - "label": "subscribe", - "id": "xstate.subscribable.subscribe_1" - } - ] + "type": "doc", + "label": "internalEvents", + "id": "xstate.typegenmeta.internalevents" }, { - "type": "category", - "label": "Subscription", - "link": { - "type": "doc", - "id": "xstate.subscription" - }, - "items": [ - { - "type": "doc", - "label": "unsubscribe", - "id": "xstate.subscription.unsubscribe" - } - ] + "type": "doc", + "label": "invokeSrcNameMap", + "id": "xstate.typegenmeta.invokesrcnamemap" }, { "type": "doc", - "label": "TagsFrom", - "id": "xstate.tagsfrom" + "label": "matchesStates", + "id": "xstate.typegenmeta.matchesstates" }, { "type": "doc", - "label": "TODO", - "id": "xstate.todo" + "label": "missingImplementations", + "id": "xstate.typegenmeta.missingimplementations" }, { "type": "doc", - "label": "toObserver", - "id": "xstate.toobserver" + "label": "tags", + "id": "xstate.typegenmeta.tags" + } + ] + }, + { + "type": "category", + "label": "UnifiedArg", + "link": { + "type": "doc", + "id": "xstate.unifiedarg" + }, + "items": [ + { + "type": "doc", + "label": "context", + "id": "xstate.unifiedarg.context" }, { "type": "doc", - "label": "TransitionActorLogic", - "id": "xstate.transitionactorlogic" + "label": "event", + "id": "xstate.unifiedarg.event" }, { - "type": "category", - "label": "TransitionConfig", - "link": { - "type": "doc", - "id": "xstate.transitionconfig" - }, - "items": [ - { - "type": "doc", - "label": "actions", - "id": "xstate.transitionconfig.actions" - }, - { - "type": "doc", - "label": "description", - "id": "xstate.transitionconfig.description" - }, - { - "type": "doc", - "label": "guard", - "id": "xstate.transitionconfig.guard" - }, - { - "type": "doc", - "label": "meta", - "id": "xstate.transitionconfig.meta" - }, - { - "type": "doc", - "label": "reenter", - "id": "xstate.transitionconfig.reenter" - }, - { - "type": "doc", - "label": "target", - "id": "xstate.transitionconfig.target" - } - ] + "type": "doc", + "label": "self", + "id": "xstate.unifiedarg.self" }, { - "type": "doc", - "label": "TransitionConfigOrTarget", - "id": "xstate.transitionconfigortarget" - }, - { - "type": "doc", - "label": "TransitionConfigTarget", - "id": "xstate.transitionconfigtarget" - }, - { - "type": "category", - "label": "TransitionDefinition", - "link": { - "type": "doc", - "id": "xstate.transitiondefinition" - }, - "items": [ - { - "type": "doc", - "label": "actions", - "id": "xstate.transitiondefinition.actions" - }, - { - "type": "doc", - "label": "eventType", - "id": "xstate.transitiondefinition.eventtype" - }, - { - "type": "doc", - "label": "guard", - "id": "xstate.transitiondefinition.guard" - }, - { - "type": "doc", - "label": "reenter", - "id": "xstate.transitiondefinition.reenter" - }, - { - "type": "doc", - "label": "source", - "id": "xstate.transitiondefinition.source" - }, - { - "type": "doc", - "label": "target", - "id": "xstate.transitiondefinition.target" - }, - { - "type": "doc", - "label": "toJSON", - "id": "xstate.transitiondefinition.tojson" - } - ] - }, - { - "type": "doc", - "label": "TransitionDefinitionMap", - "id": "xstate.transitiondefinitionmap" - }, - { - "type": "doc", - "label": "Transitions", - "id": "xstate.transitions" - }, - { - "type": "doc", - "label": "TransitionsConfig", - "id": "xstate.transitionsconfig" - }, - { - "type": "doc", - "label": "TransitionSnapshot", - "id": "xstate.transitionsnapshot" - }, - { - "type": "doc", - "label": "TransitionTarget", - "id": "xstate.transitiontarget" - }, - { - "type": "doc", - "label": "TypegenConstraint", - "id": "xstate.typegenconstraint" - }, - { - "type": "category", - "label": "TypegenDisabled", - "link": { - "type": "doc", - "id": "xstate.typegendisabled" - }, - "items": [ - { - "type": "doc", - "label": "\"@@xstate/typegen\"", - "id": "xstate.typegendisabled.___xstate_typegen_" - } - ] - }, - { - "type": "category", - "label": "TypegenEnabled", - "link": { - "type": "doc", - "id": "xstate.typegenenabled" - }, - "items": [ - { - "type": "doc", - "label": "\"@@xstate/typegen\"", - "id": "xstate.typegenenabled.___xstate_typegen_" - } - ] - }, - { - "type": "category", - "label": "TypegenMeta", - "link": { - "type": "doc", - "id": "xstate.typegenmeta" - }, - "items": [ - { - "type": "doc", - "label": "eventsCausingActions", - "id": "xstate.typegenmeta.eventscausingactions" - }, - { - "type": "doc", - "label": "eventsCausingActors", - "id": "xstate.typegenmeta.eventscausingactors" - }, - { - "type": "doc", - "label": "eventsCausingDelays", - "id": "xstate.typegenmeta.eventscausingdelays" - }, - { - "type": "doc", - "label": "eventsCausingGuards", - "id": "xstate.typegenmeta.eventscausingguards" - }, - { - "type": "doc", - "label": "internalEvents", - "id": "xstate.typegenmeta.internalevents" - }, - { - "type": "doc", - "label": "invokeSrcNameMap", - "id": "xstate.typegenmeta.invokesrcnamemap" - }, - { - "type": "doc", - "label": "matchesStates", - "id": "xstate.typegenmeta.matchesstates" - }, - { - "type": "doc", - "label": "missingImplementations", - "id": "xstate.typegenmeta.missingimplementations" - }, - { - "type": "doc", - "label": "tags", - "id": "xstate.typegenmeta.tags" - } - ] - }, - { - "type": "category", - "label": "UnifiedArg", - "link": { - "type": "doc", - "id": "xstate.unifiedarg" - }, - "items": [ - { - "type": "doc", - "label": "context", - "id": "xstate.unifiedarg.context" - }, - { - "type": "doc", - "label": "event", - "id": "xstate.unifiedarg.event" - }, - { - "type": "doc", - "label": "self", - "id": "xstate.unifiedarg.self" - }, - { - "type": "doc", - "label": "system", - "id": "xstate.unifiedarg.system" - } - ] - }, - { - "type": "doc", - "label": "UnknownAction", - "id": "xstate.unknownaction" - }, - { - "type": "doc", - "label": "Values", - "id": "xstate.values" - }, - { - "type": "doc", - "label": "waitFor", - "id": "xstate.waitfor" - }, - { - "type": "doc", - "label": "WithDynamicParams", - "id": "xstate.withdynamicparams" + "type": "doc", + "label": "system", + "id": "xstate.unifiedarg.system" } ] + }, + { + "type": "doc", + "label": "UnknownAction", + "id": "xstate.unknownaction" + }, + { + "type": "doc", + "label": "Values", + "id": "xstate.values" + }, + { + "type": "doc", + "label": "waitFor", + "id": "xstate.waitfor" + }, + { + "type": "doc", + "label": "WithDynamicParams", + "id": "xstate.withdynamicparams" } ] \ No newline at end of file From f4679b16ba413d9e5b237b807abf20ebb49cebfe Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Mon, 23 Oct 2023 10:15:31 -0500 Subject: [PATCH 42/43] api documenter plugin: omit dist/ from .gitignore --- tools/xstate-api-documenter-docusaurus-plugin/.gitignore | 1 - 1 file changed, 1 deletion(-) diff --git a/tools/xstate-api-documenter-docusaurus-plugin/.gitignore b/tools/xstate-api-documenter-docusaurus-plugin/.gitignore index b94707787..c2658d7d1 100644 --- a/tools/xstate-api-documenter-docusaurus-plugin/.gitignore +++ b/tools/xstate-api-documenter-docusaurus-plugin/.gitignore @@ -1,2 +1 @@ node_modules/ -dist/ From 37b5ff9411da8ccbe61359352a544b4f884380e5 Mon Sep 17 00:00:00 2001 From: Eric Skogen Date: Mon, 23 Oct 2023 10:44:57 -0500 Subject: [PATCH 43/43] Add API docs generated by API Documenter --- api/xstate/index.md | 259 ++++++++++++++++++ api/xstate/xstate.__resolvedtypesmetafrom.md | 29 ++ api/xstate/xstate.action.md | 20 ++ api/xstate/xstate.actionargs.action.md | 18 ++ api/xstate/xstate.actionargs.md | 26 ++ api/xstate/xstate.actionfunction.md | 27 ++ api/xstate/xstate.actionfunctionmap.md | 24 ++ api/xstate/xstate.actions.md | 20 ++ api/xstate/xstate.actor._constructor_.md | 28 ++ api/xstate/xstate.actor._parent.md | 18 ++ api/xstate/xstate.actor._symbolobservable_.md | 22 ++ api/xstate/xstate.actor.cancel.md | 29 ++ api/xstate/xstate.actor.clock.md | 20 ++ api/xstate/xstate.actor.delaysend.md | 34 +++ api/xstate/xstate.actor.getpersistedstate.md | 22 ++ api/xstate/xstate.actor.getsnapshot.md | 22 ++ api/xstate/xstate.actor.id.md | 20 ++ api/xstate/xstate.actor.logic.md | 18 ++ api/xstate/xstate.actor.md | 57 ++++ api/xstate/xstate.actor.options.md | 18 ++ api/xstate/xstate.actor.ref.md | 18 ++ api/xstate/xstate.actor.send.md | 31 +++ api/xstate/xstate.actor.sessionid.md | 20 ++ api/xstate/xstate.actor.src.md | 18 ++ api/xstate/xstate.actor.start.md | 24 ++ api/xstate/xstate.actor.status.md | 20 ++ api/xstate/xstate.actor.stop.md | 24 ++ api/xstate/xstate.actor.subscribe.md | 29 ++ api/xstate/xstate.actor.subscribe_1.md | 31 +++ api/xstate/xstate.actor.system.md | 18 ++ api/xstate/xstate.actor.tojson.md | 25 ++ api/xstate/xstate.actorcontext.defer.md | 18 ++ api/xstate/xstate.actorcontext.id.md | 18 ++ api/xstate/xstate.actorcontext.logger.md | 18 ++ api/xstate/xstate.actorcontext.md | 31 +++ api/xstate/xstate.actorcontext.self.md | 18 ++ api/xstate/xstate.actorcontext.sessionid.md | 18 ++ api/xstate/xstate.actorcontext.stopchild.md | 18 ++ api/xstate/xstate.actorcontext.system.md | 18 ++ api/xstate/xstate.actorlike.md | 26 ++ api/xstate/xstate.actorlike.send.md | 18 ++ api/xstate/xstate.actorlogic.config.md | 18 ++ .../xstate.actorlogic.getinitialstate.md | 18 ++ .../xstate.actorlogic.getpersistedstate.md | 18 ++ api/xstate/xstate.actorlogic.md | 34 +++ api/xstate/xstate.actorlogic.restorestate.md | 18 ++ api/xstate/xstate.actorlogic.start.md | 18 ++ api/xstate/xstate.actorlogic.transition.md | 18 ++ api/xstate/xstate.actorlogicfrom.md | 20 ++ api/xstate/xstate.actoroptions.clock.md | 18 ++ api/xstate/xstate.actoroptions.devtools.md | 22 ++ api/xstate/xstate.actoroptions.execute.md | 20 ++ api/xstate/xstate.actoroptions.id.md | 20 ++ api/xstate/xstate.actoroptions.input.md | 20 ++ api/xstate/xstate.actoroptions.inspect.md | 18 ++ api/xstate/xstate.actoroptions.logger.md | 18 ++ api/xstate/xstate.actoroptions.md | 36 +++ api/xstate/xstate.actoroptions.parent.md | 18 ++ api/xstate/xstate.actoroptions.src.md | 20 ++ api/xstate/xstate.actoroptions.state.md | 18 ++ api/xstate/xstate.actoroptions.sync.md | 18 ++ api/xstate/xstate.actoroptions.systemid.md | 20 ++ api/xstate/xstate.actorref._parent.md | 18 ++ .../xstate.actorref.getpersistedstate.md | 18 ++ api/xstate/xstate.actorref.getsnapshot.md | 18 ++ api/xstate/xstate.actorref.id.md | 20 ++ api/xstate/xstate.actorref.md | 37 +++ api/xstate/xstate.actorref.send.md | 18 ++ api/xstate/xstate.actorref.sessionid.md | 18 ++ api/xstate/xstate.actorref.src.md | 18 ++ api/xstate/xstate.actorref.start.md | 18 ++ api/xstate/xstate.actorref.status.md | 18 ++ api/xstate/xstate.actorref.stop.md | 18 ++ api/xstate/xstate.actorref.system.md | 18 ++ api/xstate/xstate.actorref.tojson.md | 18 ++ api/xstate/xstate.actorreffrom.md | 20 ++ api/xstate/xstate.actorstatus.md | 27 ++ api/xstate/xstate.actorsystem.get.md | 18 ++ api/xstate/xstate.actorsystem.inspect.md | 18 ++ api/xstate/xstate.actorsystem.md | 26 ++ api/xstate/xstate.actorsysteminfo.actors.md | 18 ++ api/xstate/xstate.actorsysteminfo.md | 25 ++ api/xstate/xstate.and.md | 29 ++ api/xstate/xstate.anyactor.md | 20 ++ api/xstate/xstate.anyactorcontext.md | 20 ++ api/xstate/xstate.anyactorlogic.md | 24 ++ api/xstate/xstate.anyactorref.md | 20 ++ api/xstate/xstate.anyactorsystem.md | 20 ++ api/xstate/xstate.anyeventobject.md | 20 ++ api/xstate/xstate.anyfunction.md | 18 ++ api/xstate/xstate.anyhistoryvalue.md | 20 ++ api/xstate/xstate.anyinterpreter.md | 25 ++ api/xstate/xstate.anyinvokeconfig.md | 20 ++ api/xstate/xstate.anystate.md | 24 ++ api/xstate/xstate.anystateconfig.md | 20 ++ api/xstate/xstate.anystatemachine.md | 21 ++ api/xstate/xstate.anystatenode.md | 20 ++ api/xstate/xstate.anystatenodeconfig.md | 20 ++ api/xstate/xstate.anystatenodedefinition.md | 20 ++ api/xstate/xstate.anytransitionconfig.md | 20 ++ api/xstate/xstate.anytransitiondefinition.md | 20 ++ ...reallimplementationsassumedtobeprovided.md | 22 ++ api/xstate/xstate.assign.md | 32 +++ api/xstate/xstate.assignaction._out_tactor.md | 18 ++ api/xstate/xstate.assignaction.md | 25 ++ api/xstate/xstate.assignargs.md | 26 ++ api/xstate/xstate.assignargs.spawn.md | 18 ++ api/xstate/xstate.assigner.md | 20 ++ .../xstate.atomicstatenodeconfig.initial.md | 18 ++ api/xstate/xstate.atomicstatenodeconfig.md | 29 ++ .../xstate.atomicstatenodeconfig.ondone.md | 18 ++ .../xstate.atomicstatenodeconfig.parallel.md | 18 ++ .../xstate.atomicstatenodeconfig.states.md | 18 ++ api/xstate/xstate.baseactorref.md | 25 ++ api/xstate/xstate.baseactorref.send.md | 18 ++ api/xstate/xstate.callbackactorlogic.md | 20 ++ api/xstate/xstate.cancel.md | 31 +++ api/xstate/xstate.cancelaction.md | 18 ++ api/xstate/xstate.cast.md | 18 ++ api/xstate/xstate.choose.md | 29 ++ .../xstate.chooseaction._out_taction.md | 18 ++ api/xstate/xstate.chooseaction._out_tactor.md | 18 ++ api/xstate/xstate.chooseaction._out_tdelay.md | 18 ++ api/xstate/xstate.chooseaction._out_tguard.md | 18 ++ api/xstate/xstate.chooseaction.md | 28 ++ api/xstate/xstate.choosebranch.actions.md | 18 ++ api/xstate/xstate.choosebranch.guard.md | 18 ++ api/xstate/xstate.choosebranch.md | 26 ++ api/xstate/xstate.compute.md | 20 ++ api/xstate/xstate.contextfactory.md | 23 ++ api/xstate/xstate.contextfrom.md | 20 ++ api/xstate/xstate.createactor.md | 32 +++ api/xstate/xstate.createactor_1.md | 30 ++ api/xstate/xstate.createemptyactor.md | 22 ++ api/xstate/xstate.createmachine.md | 31 +++ api/xstate/xstate.delayconfig.md | 20 ++ ...state.delayedtransitiondefinition.delay.md | 18 ++ .../xstate.delayedtransitiondefinition.md | 26 ++ api/xstate/xstate.delayedtransitions.md | 22 ++ api/xstate/xstate.delayexpr.md | 20 ++ api/xstate/xstate.delayfunctionmap.md | 20 ++ api/xstate/xstate.devtoolsadapter.md | 20 ++ api/xstate/xstate.doneactorevent.md | 26 ++ api/xstate/xstate.doneactorevent.output.md | 18 ++ api/xstate/xstate.doneactorevent.type.md | 18 ++ api/xstate/xstate.donestateevent.md | 27 ++ api/xstate/xstate.donestateevent.output.md | 18 ++ api/xstate/xstate.donestateevent.type.md | 18 ++ api/xstate/xstate.equals.md | 18 ++ api/xstate/xstate.erroractorevent.data.md | 18 ++ api/xstate/xstate.erroractorevent.md | 27 ++ api/xstate/xstate.erroractorevent.type.md | 18 ++ api/xstate/xstate.escalate.md | 32 +++ api/xstate/xstate.eventdescriptor.md | 20 ++ api/xstate/xstate.eventfrom.md | 20 ++ api/xstate/xstate.eventfromlogic.md | 20 ++ api/xstate/xstate.eventobject.md | 27 ++ api/xstate/xstate.eventobject.type.md | 20 ++ api/xstate/xstate.extractevent.md | 20 ++ api/xstate/xstate.forwardto.md | 32 +++ api/xstate/xstate.fromcallback.md | 29 ++ api/xstate/xstate.fromeventobservable.md | 37 +++ api/xstate/xstate.fromobservable.md | 33 +++ api/xstate/xstate.frompromise.md | 33 +++ api/xstate/xstate.fromtransition.md | 39 +++ api/xstate/xstate.getstatenodes.md | 32 +++ api/xstate/xstate.historystatenode.history.md | 18 ++ api/xstate/xstate.historystatenode.md | 27 ++ api/xstate/xstate.historystatenode.target.md | 18 ++ .../xstate.historystatenodeconfig.history.md | 18 ++ api/xstate/xstate.historystatenodeconfig.md | 27 ++ .../xstate.historystatenodeconfig.target.md | 18 ++ api/xstate/xstate.historyvalue.md | 20 ++ api/xstate/xstate.homomorphicomit.md | 20 ++ api/xstate/xstate.homomorphicpick.md | 20 ++ api/xstate/xstate.indexbyprop.md | 20 ++ api/xstate/xstate.indexbytype.md | 22 ++ api/xstate/xstate.inferevent.md | 26 ++ api/xstate/xstate.initialtransitionconfig.md | 26 ++ .../xstate.initialtransitionconfig.target.md | 18 ++ ...state.initialtransitiondefinition.guard.md | 18 ++ .../xstate.initialtransitiondefinition.md | 27 ++ ...tate.initialtransitiondefinition.target.md | 18 ++ api/xstate/xstate.inputfrom.md | 20 ++ .../xstate.inspectedactorevent.actorref.md | 18 ++ api/xstate/xstate.inspectedactorevent.md | 27 ++ api/xstate/xstate.inspectedactorevent.type.md | 18 ++ .../xstate.inspectedeventevent.event.md | 18 ++ api/xstate/xstate.inspectedeventevent.md | 29 ++ .../xstate.inspectedeventevent.sourceref.md | 18 ++ .../xstate.inspectedeventevent.targetref.md | 18 ++ api/xstate/xstate.inspectedeventevent.type.md | 18 ++ .../xstate.inspectedsnapshotevent.actorref.md | 18 ++ .../xstate.inspectedsnapshotevent.event.md | 18 ++ api/xstate/xstate.inspectedsnapshotevent.md | 29 ++ .../xstate.inspectedsnapshotevent.snapshot.md | 18 ++ .../xstate.inspectedsnapshotevent.type.md | 18 ++ api/xstate/xstate.inspectionevent.md | 20 ++ .../xstate.internalmachineimplementations.md | 20 ++ ...e.interopobservable._symbol.observable_.md | 18 ++ api/xstate/xstate.interopobservable.md | 25 ++ api/xstate/xstate.interopsubscribable.md | 25 ++ .../xstate.interopsubscribable.subscribe.md | 29 ++ api/xstate/xstate.interpret.md | 25 ++ api/xstate/xstate.interpreter.md | 25 ++ api/xstate/xstate.interpreterfrom.md | 25 ++ api/xstate/xstate.interpreterstatus.md | 23 ++ api/xstate/xstate.invokeconfig.md | 29 ++ api/xstate/xstate.invokedefinition.id.md | 18 ++ api/xstate/xstate.invokedefinition.input.md | 18 ++ api/xstate/xstate.invokedefinition.md | 32 +++ api/xstate/xstate.invokedefinition.ondone.md | 20 ++ api/xstate/xstate.invokedefinition.onerror.md | 20 ++ .../xstate.invokedefinition.onsnapshot.md | 18 ++ api/xstate/xstate.invokedefinition.src.md | 20 ++ .../xstate.invokedefinition.systemid.md | 18 ++ api/xstate/xstate.invokedefinition.tojson.md | 18 ++ api/xstate/xstate.isany.md | 20 ++ api/xstate/xstate.isliteralstring.md | 18 ++ api/xstate/xstate.isnever.md | 18 ++ api/xstate/xstate.lazy.md | 18 ++ api/xstate/xstate.log.md | 30 ++ api/xstate/xstate.logaction.md | 18 ++ api/xstate/xstate.logexpr.md | 20 ++ api/xstate/xstate.lowinfer.md | 18 ++ api/xstate/xstate.machineconfig.md | 28 ++ api/xstate/xstate.machinecontext.md | 18 ++ api/xstate/xstate.machineimplementations.md | 20 ++ .../xstate.machineimplementationsfrom.md | 20 ++ ...achineimplementationssimplified.actions.md | 18 ++ ...machineimplementationssimplified.actors.md | 21 ++ ...machineimplementationssimplified.delays.md | 18 ++ ...machineimplementationssimplified.guards.md | 18 ++ ...xstate.machineimplementationssimplified.md | 28 ++ api/xstate/xstate.machinesnapshot.md | 36 +++ api/xstate/xstate.machinetypes.actions.md | 18 ++ api/xstate/xstate.machinetypes.actors.md | 18 ++ api/xstate/xstate.machinetypes.context.md | 18 ++ api/xstate/xstate.machinetypes.delays.md | 18 ++ api/xstate/xstate.machinetypes.events.md | 18 ++ api/xstate/xstate.machinetypes.guards.md | 18 ++ api/xstate/xstate.machinetypes.input.md | 18 ++ api/xstate/xstate.machinetypes.md | 34 +++ api/xstate/xstate.machinetypes.output.md | 18 ++ api/xstate/xstate.machinetypes.tags.md | 18 ++ api/xstate/xstate.machinetypes.typegen.md | 18 ++ api/xstate/xstate.mapper.md | 24 ++ api/xstate/xstate.mapstate.md | 32 +++ ...mentationsasprovided.___xstate_typegen_.md | 18 ++ ...xstate.markallimplementationsasprovided.md | 26 ++ ...rkallimplementationsasprovided.resolved.md | 18 ++ api/xstate/xstate.matchesstate.md | 30 ++ api/xstate/xstate.maybelazy.md | 20 ++ api/xstate/xstate.merge.md | 18 ++ api/xstate/xstate.metaobject.md | 18 ++ .../xstate.missingimplementationserror.md | 25 ++ api/xstate/xstate.noinfer.md | 18 ++ api/xstate/xstate.nonreducibleunknown.md | 26 ++ api/xstate/xstate.norequiredparams.md | 22 ++ api/xstate/xstate.not.md | 29 ++ api/xstate/xstate.observableactorlogic.md | 23 ++ api/xstate/xstate.observer.md | 22 ++ api/xstate/xstate.or.md | 29 ++ api/xstate/xstate.outputfrom.md | 22 ++ api/xstate/xstate.parameterizedobject.md | 26 ++ .../xstate.parameterizedobject.params.md | 18 ++ api/xstate/xstate.parameterizedobject.type.md | 18 ++ api/xstate/xstate.partialassigner.md | 20 ++ api/xstate/xstate.pathtostatevalue.md | 29 ++ api/xstate/xstate.persistedmachinestate.md | 27 ++ api/xstate/xstate.persistedstatefrom.md | 20 ++ api/xstate/xstate.promiseactorlogic.md | 25 ++ api/xstate/xstate.prop.md | 18 ++ api/xstate/xstate.propertyassigner.md | 22 ++ api/xstate/xstate.providedactor.id.md | 18 ++ api/xstate/xstate.providedactor.logic.md | 18 ++ api/xstate/xstate.providedactor.md | 27 ++ api/xstate/xstate.providedactor.src.md | 18 ++ api/xstate/xstate.pure.md | 32 +++ api/xstate/xstate.pureaction._out_taction.md | 18 ++ api/xstate/xstate.pureaction._out_tactor.md | 18 ++ api/xstate/xstate.pureaction._out_tdelay.md | 18 ++ api/xstate/xstate.pureaction._out_tevent.md | 18 ++ api/xstate/xstate.pureaction._out_tguard.md | 18 ++ api/xstate/xstate.pureaction.md | 29 ++ api/xstate/xstate.raise.md | 32 +++ api/xstate/xstate.raiseaction._out_tdelay.md | 18 ++ api/xstate/xstate.raiseaction._out_tevent.md | 18 ++ api/xstate/xstate.raiseaction.md | 26 ++ api/xstate/xstate.raiseactionoptions.delay.md | 18 ++ api/xstate/xstate.raiseactionoptions.id.md | 18 ++ api/xstate/xstate.raiseactionoptions.md | 26 ++ api/xstate/xstate.raiseactionparams.event.md | 18 ++ api/xstate/xstate.raiseactionparams.md | 26 ++ api/xstate/xstate.resolvedtypegenmeta.md | 26 ++ .../xstate.resolvedtypegenmeta.resolved.md | 24 ++ ...e.resolvetypegenmeta.___xstate_typegen_.md | 18 ++ api/xstate/xstate.resolvetypegenmeta.md | 26 ++ .../xstate.resolvetypegenmeta.resolved.md | 38 +++ api/xstate/xstate.sendexpr.md | 20 ++ api/xstate/xstate.sendparent.md | 32 +++ api/xstate/xstate.sendto.md | 33 +++ api/xstate/xstate.sendtoaction._out_tdelay.md | 18 ++ api/xstate/xstate.sendtoaction.md | 25 ++ api/xstate/xstate.sendtoactionoptions.md | 20 ++ api/xstate/xstate.sendtoactionparams.event.md | 18 ++ api/xstate/xstate.sendtoactionparams.md | 26 ++ api/xstate/xstate.simpleorstatenodeconfig.md | 20 ++ .../xstate.simulatedclock.cleartimeout.md | 29 ++ api/xstate/xstate.simulatedclock.increment.md | 29 ++ api/xstate/xstate.simulatedclock.md | 28 ++ api/xstate/xstate.simulatedclock.now.md | 22 ++ api/xstate/xstate.simulatedclock.set.md | 29 ++ .../xstate.simulatedclock.settimeout.md | 30 ++ api/xstate/xstate.simulatedclock.start.md | 29 ++ api/xstate/xstate.singleorarray.md | 18 ++ api/xstate/xstate.snapshot.md | 34 +++ api/xstate/xstate.snapshotevent.md | 27 ++ api/xstate/xstate.snapshotevent.snapshot.md | 18 ++ api/xstate/xstate.snapshotevent.type.md | 18 ++ api/xstate/xstate.snapshotfrom.md | 20 ++ api/xstate/xstate.spawner.md | 27 ++ api/xstate/xstate.specialtargets.md | 26 ++ api/xstate/xstate.state._constructor_.md | 28 ++ api/xstate/xstate.state.can.md | 33 +++ api/xstate/xstate.state.children.md | 20 ++ api/xstate/xstate.state.configuration.md | 20 ++ api/xstate/xstate.state.context.md | 18 ++ api/xstate/xstate.state.error.md | 20 ++ api/xstate/xstate.state.from.md | 35 +++ api/xstate/xstate.state.hastag.md | 31 +++ api/xstate/xstate.state.historyvalue.md | 18 ++ api/xstate/xstate.state.machine.md | 18 ++ api/xstate/xstate.state.matches.md | 31 +++ api/xstate/xstate.state.md | 52 ++++ api/xstate/xstate.state.meta.md | 18 ++ api/xstate/xstate.state.nextevents.md | 20 ++ api/xstate/xstate.state.status.md | 20 ++ api/xstate/xstate.state.tags.md | 18 ++ api/xstate/xstate.state.tojson.md | 25 ++ api/xstate/xstate.state.tostrings.md | 31 +++ api/xstate/xstate.state.value.md | 18 ++ api/xstate/xstate.stateconfig.children.md | 18 ++ .../xstate.stateconfig.configuration.md | 18 ++ api/xstate/xstate.stateconfig.context.md | 18 ++ api/xstate/xstate.stateconfig.error.md | 18 ++ api/xstate/xstate.stateconfig.historyvalue.md | 18 ++ api/xstate/xstate.stateconfig.machine.md | 18 ++ api/xstate/xstate.stateconfig.md | 35 +++ api/xstate/xstate.stateconfig.meta.md | 18 ++ api/xstate/xstate.stateconfig.output.md | 18 ++ api/xstate/xstate.stateconfig.status.md | 18 ++ api/xstate/xstate.stateconfig.tags.md | 18 ++ api/xstate/xstate.stateconfig.value.md | 18 ++ api/xstate/xstate.statefrom.md | 20 ++ api/xstate/xstate.statein.md | 29 ++ api/xstate/xstate.statekey.md | 20 ++ api/xstate/xstate.statelike.context.md | 18 ++ api/xstate/xstate.statelike.event.md | 18 ++ api/xstate/xstate.statelike.md | 27 ++ api/xstate/xstate.statelike.value.md | 18 ++ api/xstate/xstate.statemachine.__taction.md | 23 ++ api/xstate/xstate.statemachine.__tactor.md | 23 ++ api/xstate/xstate.statemachine.__tcontext.md | 23 ++ api/xstate/xstate.statemachine.__tdelay.md | 23 ++ api/xstate/xstate.statemachine.__tevent.md | 23 ++ api/xstate/xstate.statemachine.__tguard.md | 23 ++ api/xstate/xstate.statemachine.__tinput.md | 23 ++ api/xstate/xstate.statemachine.__toutput.md | 23 ++ ...state.statemachine.__tresolvedtypesmeta.md | 23 ++ api/xstate/xstate.statemachine.__ttag.md | 23 ++ .../xstate.statemachine.__xstatenode.md | 18 ++ .../xstate.statemachine._constructor_.md | 29 ++ api/xstate/xstate.statemachine.config.md | 20 ++ api/xstate/xstate.statemachine.createstate.md | 29 ++ api/xstate/xstate.statemachine.definition.md | 18 ++ api/xstate/xstate.statemachine.events.md | 18 ++ .../xstate.statemachine.getinitialstate.md | 32 +++ .../xstate.statemachine.getpersistedstate.md | 29 ++ .../xstate.statemachine.getstatenodebyid.md | 29 ++ .../xstate.statemachine.gettransitiondata.md | 30 ++ api/xstate/xstate.statemachine.id.md | 18 ++ api/xstate/xstate.statemachine.idmap.md | 18 ++ .../xstate.statemachine.implementations.md | 18 ++ api/xstate/xstate.statemachine.md | 70 +++++ api/xstate/xstate.statemachine.microstep.md | 33 +++ api/xstate/xstate.statemachine.provide.md | 33 +++ .../xstate.statemachine.resolvestate.md | 33 +++ .../xstate.statemachine.resolvestatevalue.md | 30 ++ .../xstate.statemachine.restorestate.md | 30 ++ api/xstate/xstate.statemachine.root.md | 18 ++ api/xstate/xstate.statemachine.start.md | 29 ++ api/xstate/xstate.statemachine.states.md | 18 ++ api/xstate/xstate.statemachine.tojson.md | 22 ++ api/xstate/xstate.statemachine.transition.md | 33 +++ api/xstate/xstate.statemachine.types.md | 18 ++ api/xstate/xstate.statemachine.version.md | 20 ++ api/xstate/xstate.statemachinedefinition.md | 20 ++ api/xstate/xstate.statenode._constructor_.md | 34 +++ api/xstate/xstate.statenode._initialize.md | 22 ++ api/xstate/xstate.statenode.after.md | 18 ++ api/xstate/xstate.statenode.always.md | 18 ++ api/xstate/xstate.statenode.config.md | 25 ++ api/xstate/xstate.statenode.definition.md | 20 ++ api/xstate/xstate.statenode.description.md | 18 ++ api/xstate/xstate.statenode.entry.md | 20 ++ api/xstate/xstate.statenode.events.md | 20 ++ api/xstate/xstate.statenode.exit.md | 20 ++ api/xstate/xstate.statenode.history.md | 22 ++ api/xstate/xstate.statenode.id.md | 20 ++ api/xstate/xstate.statenode.initial.md | 18 ++ api/xstate/xstate.statenode.invoke.md | 20 ++ api/xstate/xstate.statenode.key.md | 20 ++ api/xstate/xstate.statenode.machine.md | 26 ++ api/xstate/xstate.statenode.md | 63 +++++ api/xstate/xstate.statenode.meta.md | 20 ++ api/xstate/xstate.statenode.next.md | 30 ++ api/xstate/xstate.statenode.on.md | 20 ++ api/xstate/xstate.statenode.order.md | 20 ++ api/xstate/xstate.statenode.output.md | 20 ++ api/xstate/xstate.statenode.ownevents.md | 22 ++ api/xstate/xstate.statenode.parent.md | 20 ++ api/xstate/xstate.statenode.path.md | 20 ++ api/xstate/xstate.statenode.states.md | 20 ++ api/xstate/xstate.statenode.tags.md | 18 ++ api/xstate/xstate.statenode.tojson.md | 22 ++ api/xstate/xstate.statenode.transitions.md | 18 ++ api/xstate/xstate.statenode.type.md | 22 ++ api/xstate/xstate.statenodeconfig.after.md | 20 ++ api/xstate/xstate.statenodeconfig.always.md | 20 ++ .../xstate.statenodeconfig.description.md | 20 ++ api/xstate/xstate.statenodeconfig.entry.md | 20 ++ api/xstate/xstate.statenodeconfig.exit.md | 20 ++ api/xstate/xstate.statenodeconfig.history.md | 20 ++ api/xstate/xstate.statenodeconfig.id.md | 20 ++ api/xstate/xstate.statenodeconfig.initial.md | 20 ++ api/xstate/xstate.statenodeconfig.invoke.md | 20 ++ api/xstate/xstate.statenodeconfig.md | 42 +++ api/xstate/xstate.statenodeconfig.meta.md | 20 ++ api/xstate/xstate.statenodeconfig.on.md | 20 ++ api/xstate/xstate.statenodeconfig.ondone.md | 22 ++ api/xstate/xstate.statenodeconfig.order.md | 20 ++ api/xstate/xstate.statenodeconfig.output.md | 22 ++ api/xstate/xstate.statenodeconfig.states.md | 20 ++ api/xstate/xstate.statenodeconfig.tags.md | 20 ++ api/xstate/xstate.statenodeconfig.target.md | 20 ++ api/xstate/xstate.statenodeconfig.type.md | 22 ++ .../xstate.statenodedefinition.description.md | 18 ++ .../xstate.statenodedefinition.entry.md | 18 ++ api/xstate/xstate.statenodedefinition.exit.md | 18 ++ .../xstate.statenodedefinition.history.md | 18 ++ api/xstate/xstate.statenodedefinition.id.md | 18 ++ .../xstate.statenodedefinition.initial.md | 18 ++ .../xstate.statenodedefinition.invoke.md | 18 ++ api/xstate/xstate.statenodedefinition.key.md | 18 ++ api/xstate/xstate.statenodedefinition.md | 41 +++ api/xstate/xstate.statenodedefinition.meta.md | 18 ++ api/xstate/xstate.statenodedefinition.on.md | 18 ++ .../xstate.statenodedefinition.order.md | 18 ++ .../xstate.statenodedefinition.output.md | 18 ++ .../xstate.statenodedefinition.states.md | 18 ++ api/xstate/xstate.statenodedefinition.tags.md | 18 ++ .../xstate.statenodedefinition.transitions.md | 18 ++ api/xstate/xstate.statenodedefinition.type.md | 18 ++ .../xstate.statenodedefinition.version.md | 18 ++ api/xstate/xstate.statenodesconfig.md | 22 ++ api/xstate/xstate.statesconfig.md | 22 ++ api/xstate/xstate.statesdefinition.md | 22 ++ api/xstate/xstate.statetypes.md | 18 ++ api/xstate/xstate.statevalue.md | 26 ++ api/xstate/xstate.statevaluefrom.md | 20 ++ api/xstate/xstate.statevaluemap.md | 18 ++ api/xstate/xstate.stop_2.md | 31 +++ api/xstate/xstate.stopaction.md | 18 ++ api/xstate/xstate.subscribable.md | 27 ++ api/xstate/xstate.subscribable.subscribe.md | 29 ++ api/xstate/xstate.subscribable.subscribe_1.md | 31 +++ api/xstate/xstate.subscription.md | 25 ++ api/xstate/xstate.subscription.unsubscribe.md | 22 ++ api/xstate/xstate.tagsfrom.md | 20 ++ api/xstate/xstate.todo.md | 18 ++ api/xstate/xstate.toobserver.md | 31 +++ api/xstate/xstate.transitionactorlogic.md | 20 ++ api/xstate/xstate.transitionconfig.actions.md | 18 ++ .../xstate.transitionconfig.description.md | 18 ++ api/xstate/xstate.transitionconfig.guard.md | 18 ++ api/xstate/xstate.transitionconfig.md | 30 ++ api/xstate/xstate.transitionconfig.meta.md | 18 ++ api/xstate/xstate.transitionconfig.reenter.md | 18 ++ api/xstate/xstate.transitionconfig.target.md | 18 ++ api/xstate/xstate.transitionconfigortarget.md | 20 ++ api/xstate/xstate.transitionconfigtarget.md | 18 ++ .../xstate.transitiondefinition.actions.md | 18 ++ .../xstate.transitiondefinition.eventtype.md | 18 ++ .../xstate.transitiondefinition.guard.md | 18 ++ api/xstate/xstate.transitiondefinition.md | 32 +++ .../xstate.transitiondefinition.reenter.md | 18 ++ .../xstate.transitiondefinition.source.md | 18 ++ .../xstate.transitiondefinition.target.md | 18 ++ .../xstate.transitiondefinition.tojson.md | 25 ++ api/xstate/xstate.transitiondefinitionmap.md | 22 ++ api/xstate/xstate.transitions.md | 20 ++ api/xstate/xstate.transitionsconfig.md | 22 ++ api/xstate/xstate.transitionsnapshot.md | 22 ++ api/xstate/xstate.transitiontarget.md | 20 ++ api/xstate/xstate.typegenconstraint.md | 20 ++ ...tate.typegendisabled.___xstate_typegen_.md | 18 ++ api/xstate/xstate.typegendisabled.md | 25 ++ ...state.typegenenabled.___xstate_typegen_.md | 18 ++ api/xstate/xstate.typegenenabled.md | 25 ++ ...xstate.typegenmeta.eventscausingactions.md | 22 ++ .../xstate.typegenmeta.eventscausingactors.md | 22 ++ .../xstate.typegenmeta.eventscausingdelays.md | 22 ++ .../xstate.typegenmeta.eventscausingguards.md | 22 ++ .../xstate.typegenmeta.internalevents.md | 22 ++ .../xstate.typegenmeta.invokesrcnamemap.md | 22 ++ .../xstate.typegenmeta.matchesstates.md | 20 ++ api/xstate/xstate.typegenmeta.md | 34 +++ ...tate.typegenmeta.missingimplementations.md | 25 ++ api/xstate/xstate.typegenmeta.tags.md | 20 ++ api/xstate/xstate.unifiedarg.context.md | 18 ++ api/xstate/xstate.unifiedarg.event.md | 18 ++ api/xstate/xstate.unifiedarg.md | 28 ++ api/xstate/xstate.unifiedarg.self.md | 18 ++ api/xstate/xstate.unifiedarg.system.md | 18 ++ api/xstate/xstate.unknownaction.md | 20 ++ api/xstate/xstate.values.md | 18 ++ api/xstate/xstate.waitfor.md | 46 ++++ api/xstate/xstate.withdynamicparams.md | 26 ++ 529 files changed, 12072 insertions(+) create mode 100644 api/xstate/index.md create mode 100644 api/xstate/xstate.__resolvedtypesmetafrom.md create mode 100644 api/xstate/xstate.action.md create mode 100644 api/xstate/xstate.actionargs.action.md create mode 100644 api/xstate/xstate.actionargs.md create mode 100644 api/xstate/xstate.actionfunction.md create mode 100644 api/xstate/xstate.actionfunctionmap.md create mode 100644 api/xstate/xstate.actions.md create mode 100644 api/xstate/xstate.actor._constructor_.md create mode 100644 api/xstate/xstate.actor._parent.md create mode 100644 api/xstate/xstate.actor._symbolobservable_.md create mode 100644 api/xstate/xstate.actor.cancel.md create mode 100644 api/xstate/xstate.actor.clock.md create mode 100644 api/xstate/xstate.actor.delaysend.md create mode 100644 api/xstate/xstate.actor.getpersistedstate.md create mode 100644 api/xstate/xstate.actor.getsnapshot.md create mode 100644 api/xstate/xstate.actor.id.md create mode 100644 api/xstate/xstate.actor.logic.md create mode 100644 api/xstate/xstate.actor.md create mode 100644 api/xstate/xstate.actor.options.md create mode 100644 api/xstate/xstate.actor.ref.md create mode 100644 api/xstate/xstate.actor.send.md create mode 100644 api/xstate/xstate.actor.sessionid.md create mode 100644 api/xstate/xstate.actor.src.md create mode 100644 api/xstate/xstate.actor.start.md create mode 100644 api/xstate/xstate.actor.status.md create mode 100644 api/xstate/xstate.actor.stop.md create mode 100644 api/xstate/xstate.actor.subscribe.md create mode 100644 api/xstate/xstate.actor.subscribe_1.md create mode 100644 api/xstate/xstate.actor.system.md create mode 100644 api/xstate/xstate.actor.tojson.md create mode 100644 api/xstate/xstate.actorcontext.defer.md create mode 100644 api/xstate/xstate.actorcontext.id.md create mode 100644 api/xstate/xstate.actorcontext.logger.md create mode 100644 api/xstate/xstate.actorcontext.md create mode 100644 api/xstate/xstate.actorcontext.self.md create mode 100644 api/xstate/xstate.actorcontext.sessionid.md create mode 100644 api/xstate/xstate.actorcontext.stopchild.md create mode 100644 api/xstate/xstate.actorcontext.system.md create mode 100644 api/xstate/xstate.actorlike.md create mode 100644 api/xstate/xstate.actorlike.send.md create mode 100644 api/xstate/xstate.actorlogic.config.md create mode 100644 api/xstate/xstate.actorlogic.getinitialstate.md create mode 100644 api/xstate/xstate.actorlogic.getpersistedstate.md create mode 100644 api/xstate/xstate.actorlogic.md create mode 100644 api/xstate/xstate.actorlogic.restorestate.md create mode 100644 api/xstate/xstate.actorlogic.start.md create mode 100644 api/xstate/xstate.actorlogic.transition.md create mode 100644 api/xstate/xstate.actorlogicfrom.md create mode 100644 api/xstate/xstate.actoroptions.clock.md create mode 100644 api/xstate/xstate.actoroptions.devtools.md create mode 100644 api/xstate/xstate.actoroptions.execute.md create mode 100644 api/xstate/xstate.actoroptions.id.md create mode 100644 api/xstate/xstate.actoroptions.input.md create mode 100644 api/xstate/xstate.actoroptions.inspect.md create mode 100644 api/xstate/xstate.actoroptions.logger.md create mode 100644 api/xstate/xstate.actoroptions.md create mode 100644 api/xstate/xstate.actoroptions.parent.md create mode 100644 api/xstate/xstate.actoroptions.src.md create mode 100644 api/xstate/xstate.actoroptions.state.md create mode 100644 api/xstate/xstate.actoroptions.sync.md create mode 100644 api/xstate/xstate.actoroptions.systemid.md create mode 100644 api/xstate/xstate.actorref._parent.md create mode 100644 api/xstate/xstate.actorref.getpersistedstate.md create mode 100644 api/xstate/xstate.actorref.getsnapshot.md create mode 100644 api/xstate/xstate.actorref.id.md create mode 100644 api/xstate/xstate.actorref.md create mode 100644 api/xstate/xstate.actorref.send.md create mode 100644 api/xstate/xstate.actorref.sessionid.md create mode 100644 api/xstate/xstate.actorref.src.md create mode 100644 api/xstate/xstate.actorref.start.md create mode 100644 api/xstate/xstate.actorref.status.md create mode 100644 api/xstate/xstate.actorref.stop.md create mode 100644 api/xstate/xstate.actorref.system.md create mode 100644 api/xstate/xstate.actorref.tojson.md create mode 100644 api/xstate/xstate.actorreffrom.md create mode 100644 api/xstate/xstate.actorstatus.md create mode 100644 api/xstate/xstate.actorsystem.get.md create mode 100644 api/xstate/xstate.actorsystem.inspect.md create mode 100644 api/xstate/xstate.actorsystem.md create mode 100644 api/xstate/xstate.actorsysteminfo.actors.md create mode 100644 api/xstate/xstate.actorsysteminfo.md create mode 100644 api/xstate/xstate.and.md create mode 100644 api/xstate/xstate.anyactor.md create mode 100644 api/xstate/xstate.anyactorcontext.md create mode 100644 api/xstate/xstate.anyactorlogic.md create mode 100644 api/xstate/xstate.anyactorref.md create mode 100644 api/xstate/xstate.anyactorsystem.md create mode 100644 api/xstate/xstate.anyeventobject.md create mode 100644 api/xstate/xstate.anyfunction.md create mode 100644 api/xstate/xstate.anyhistoryvalue.md create mode 100644 api/xstate/xstate.anyinterpreter.md create mode 100644 api/xstate/xstate.anyinvokeconfig.md create mode 100644 api/xstate/xstate.anystate.md create mode 100644 api/xstate/xstate.anystateconfig.md create mode 100644 api/xstate/xstate.anystatemachine.md create mode 100644 api/xstate/xstate.anystatenode.md create mode 100644 api/xstate/xstate.anystatenodeconfig.md create mode 100644 api/xstate/xstate.anystatenodedefinition.md create mode 100644 api/xstate/xstate.anytransitionconfig.md create mode 100644 api/xstate/xstate.anytransitiondefinition.md create mode 100644 api/xstate/xstate.areallimplementationsassumedtobeprovided.md create mode 100644 api/xstate/xstate.assign.md create mode 100644 api/xstate/xstate.assignaction._out_tactor.md create mode 100644 api/xstate/xstate.assignaction.md create mode 100644 api/xstate/xstate.assignargs.md create mode 100644 api/xstate/xstate.assignargs.spawn.md create mode 100644 api/xstate/xstate.assigner.md create mode 100644 api/xstate/xstate.atomicstatenodeconfig.initial.md create mode 100644 api/xstate/xstate.atomicstatenodeconfig.md create mode 100644 api/xstate/xstate.atomicstatenodeconfig.ondone.md create mode 100644 api/xstate/xstate.atomicstatenodeconfig.parallel.md create mode 100644 api/xstate/xstate.atomicstatenodeconfig.states.md create mode 100644 api/xstate/xstate.baseactorref.md create mode 100644 api/xstate/xstate.baseactorref.send.md create mode 100644 api/xstate/xstate.callbackactorlogic.md create mode 100644 api/xstate/xstate.cancel.md create mode 100644 api/xstate/xstate.cancelaction.md create mode 100644 api/xstate/xstate.cast.md create mode 100644 api/xstate/xstate.choose.md create mode 100644 api/xstate/xstate.chooseaction._out_taction.md create mode 100644 api/xstate/xstate.chooseaction._out_tactor.md create mode 100644 api/xstate/xstate.chooseaction._out_tdelay.md create mode 100644 api/xstate/xstate.chooseaction._out_tguard.md create mode 100644 api/xstate/xstate.chooseaction.md create mode 100644 api/xstate/xstate.choosebranch.actions.md create mode 100644 api/xstate/xstate.choosebranch.guard.md create mode 100644 api/xstate/xstate.choosebranch.md create mode 100644 api/xstate/xstate.compute.md create mode 100644 api/xstate/xstate.contextfactory.md create mode 100644 api/xstate/xstate.contextfrom.md create mode 100644 api/xstate/xstate.createactor.md create mode 100644 api/xstate/xstate.createactor_1.md create mode 100644 api/xstate/xstate.createemptyactor.md create mode 100644 api/xstate/xstate.createmachine.md create mode 100644 api/xstate/xstate.delayconfig.md create mode 100644 api/xstate/xstate.delayedtransitiondefinition.delay.md create mode 100644 api/xstate/xstate.delayedtransitiondefinition.md create mode 100644 api/xstate/xstate.delayedtransitions.md create mode 100644 api/xstate/xstate.delayexpr.md create mode 100644 api/xstate/xstate.delayfunctionmap.md create mode 100644 api/xstate/xstate.devtoolsadapter.md create mode 100644 api/xstate/xstate.doneactorevent.md create mode 100644 api/xstate/xstate.doneactorevent.output.md create mode 100644 api/xstate/xstate.doneactorevent.type.md create mode 100644 api/xstate/xstate.donestateevent.md create mode 100644 api/xstate/xstate.donestateevent.output.md create mode 100644 api/xstate/xstate.donestateevent.type.md create mode 100644 api/xstate/xstate.equals.md create mode 100644 api/xstate/xstate.erroractorevent.data.md create mode 100644 api/xstate/xstate.erroractorevent.md create mode 100644 api/xstate/xstate.erroractorevent.type.md create mode 100644 api/xstate/xstate.escalate.md create mode 100644 api/xstate/xstate.eventdescriptor.md create mode 100644 api/xstate/xstate.eventfrom.md create mode 100644 api/xstate/xstate.eventfromlogic.md create mode 100644 api/xstate/xstate.eventobject.md create mode 100644 api/xstate/xstate.eventobject.type.md create mode 100644 api/xstate/xstate.extractevent.md create mode 100644 api/xstate/xstate.forwardto.md create mode 100644 api/xstate/xstate.fromcallback.md create mode 100644 api/xstate/xstate.fromeventobservable.md create mode 100644 api/xstate/xstate.fromobservable.md create mode 100644 api/xstate/xstate.frompromise.md create mode 100644 api/xstate/xstate.fromtransition.md create mode 100644 api/xstate/xstate.getstatenodes.md create mode 100644 api/xstate/xstate.historystatenode.history.md create mode 100644 api/xstate/xstate.historystatenode.md create mode 100644 api/xstate/xstate.historystatenode.target.md create mode 100644 api/xstate/xstate.historystatenodeconfig.history.md create mode 100644 api/xstate/xstate.historystatenodeconfig.md create mode 100644 api/xstate/xstate.historystatenodeconfig.target.md create mode 100644 api/xstate/xstate.historyvalue.md create mode 100644 api/xstate/xstate.homomorphicomit.md create mode 100644 api/xstate/xstate.homomorphicpick.md create mode 100644 api/xstate/xstate.indexbyprop.md create mode 100644 api/xstate/xstate.indexbytype.md create mode 100644 api/xstate/xstate.inferevent.md create mode 100644 api/xstate/xstate.initialtransitionconfig.md create mode 100644 api/xstate/xstate.initialtransitionconfig.target.md create mode 100644 api/xstate/xstate.initialtransitiondefinition.guard.md create mode 100644 api/xstate/xstate.initialtransitiondefinition.md create mode 100644 api/xstate/xstate.initialtransitiondefinition.target.md create mode 100644 api/xstate/xstate.inputfrom.md create mode 100644 api/xstate/xstate.inspectedactorevent.actorref.md create mode 100644 api/xstate/xstate.inspectedactorevent.md create mode 100644 api/xstate/xstate.inspectedactorevent.type.md create mode 100644 api/xstate/xstate.inspectedeventevent.event.md create mode 100644 api/xstate/xstate.inspectedeventevent.md create mode 100644 api/xstate/xstate.inspectedeventevent.sourceref.md create mode 100644 api/xstate/xstate.inspectedeventevent.targetref.md create mode 100644 api/xstate/xstate.inspectedeventevent.type.md create mode 100644 api/xstate/xstate.inspectedsnapshotevent.actorref.md create mode 100644 api/xstate/xstate.inspectedsnapshotevent.event.md create mode 100644 api/xstate/xstate.inspectedsnapshotevent.md create mode 100644 api/xstate/xstate.inspectedsnapshotevent.snapshot.md create mode 100644 api/xstate/xstate.inspectedsnapshotevent.type.md create mode 100644 api/xstate/xstate.inspectionevent.md create mode 100644 api/xstate/xstate.internalmachineimplementations.md create mode 100644 api/xstate/xstate.interopobservable._symbol.observable_.md create mode 100644 api/xstate/xstate.interopobservable.md create mode 100644 api/xstate/xstate.interopsubscribable.md create mode 100644 api/xstate/xstate.interopsubscribable.subscribe.md create mode 100644 api/xstate/xstate.interpret.md create mode 100644 api/xstate/xstate.interpreter.md create mode 100644 api/xstate/xstate.interpreterfrom.md create mode 100644 api/xstate/xstate.interpreterstatus.md create mode 100644 api/xstate/xstate.invokeconfig.md create mode 100644 api/xstate/xstate.invokedefinition.id.md create mode 100644 api/xstate/xstate.invokedefinition.input.md create mode 100644 api/xstate/xstate.invokedefinition.md create mode 100644 api/xstate/xstate.invokedefinition.ondone.md create mode 100644 api/xstate/xstate.invokedefinition.onerror.md create mode 100644 api/xstate/xstate.invokedefinition.onsnapshot.md create mode 100644 api/xstate/xstate.invokedefinition.src.md create mode 100644 api/xstate/xstate.invokedefinition.systemid.md create mode 100644 api/xstate/xstate.invokedefinition.tojson.md create mode 100644 api/xstate/xstate.isany.md create mode 100644 api/xstate/xstate.isliteralstring.md create mode 100644 api/xstate/xstate.isnever.md create mode 100644 api/xstate/xstate.lazy.md create mode 100644 api/xstate/xstate.log.md create mode 100644 api/xstate/xstate.logaction.md create mode 100644 api/xstate/xstate.logexpr.md create mode 100644 api/xstate/xstate.lowinfer.md create mode 100644 api/xstate/xstate.machineconfig.md create mode 100644 api/xstate/xstate.machinecontext.md create mode 100644 api/xstate/xstate.machineimplementations.md create mode 100644 api/xstate/xstate.machineimplementationsfrom.md create mode 100644 api/xstate/xstate.machineimplementationssimplified.actions.md create mode 100644 api/xstate/xstate.machineimplementationssimplified.actors.md create mode 100644 api/xstate/xstate.machineimplementationssimplified.delays.md create mode 100644 api/xstate/xstate.machineimplementationssimplified.guards.md create mode 100644 api/xstate/xstate.machineimplementationssimplified.md create mode 100644 api/xstate/xstate.machinesnapshot.md create mode 100644 api/xstate/xstate.machinetypes.actions.md create mode 100644 api/xstate/xstate.machinetypes.actors.md create mode 100644 api/xstate/xstate.machinetypes.context.md create mode 100644 api/xstate/xstate.machinetypes.delays.md create mode 100644 api/xstate/xstate.machinetypes.events.md create mode 100644 api/xstate/xstate.machinetypes.guards.md create mode 100644 api/xstate/xstate.machinetypes.input.md create mode 100644 api/xstate/xstate.machinetypes.md create mode 100644 api/xstate/xstate.machinetypes.output.md create mode 100644 api/xstate/xstate.machinetypes.tags.md create mode 100644 api/xstate/xstate.machinetypes.typegen.md create mode 100644 api/xstate/xstate.mapper.md create mode 100644 api/xstate/xstate.mapstate.md create mode 100644 api/xstate/xstate.markallimplementationsasprovided.___xstate_typegen_.md create mode 100644 api/xstate/xstate.markallimplementationsasprovided.md create mode 100644 api/xstate/xstate.markallimplementationsasprovided.resolved.md create mode 100644 api/xstate/xstate.matchesstate.md create mode 100644 api/xstate/xstate.maybelazy.md create mode 100644 api/xstate/xstate.merge.md create mode 100644 api/xstate/xstate.metaobject.md create mode 100644 api/xstate/xstate.missingimplementationserror.md create mode 100644 api/xstate/xstate.noinfer.md create mode 100644 api/xstate/xstate.nonreducibleunknown.md create mode 100644 api/xstate/xstate.norequiredparams.md create mode 100644 api/xstate/xstate.not.md create mode 100644 api/xstate/xstate.observableactorlogic.md create mode 100644 api/xstate/xstate.observer.md create mode 100644 api/xstate/xstate.or.md create mode 100644 api/xstate/xstate.outputfrom.md create mode 100644 api/xstate/xstate.parameterizedobject.md create mode 100644 api/xstate/xstate.parameterizedobject.params.md create mode 100644 api/xstate/xstate.parameterizedobject.type.md create mode 100644 api/xstate/xstate.partialassigner.md create mode 100644 api/xstate/xstate.pathtostatevalue.md create mode 100644 api/xstate/xstate.persistedmachinestate.md create mode 100644 api/xstate/xstate.persistedstatefrom.md create mode 100644 api/xstate/xstate.promiseactorlogic.md create mode 100644 api/xstate/xstate.prop.md create mode 100644 api/xstate/xstate.propertyassigner.md create mode 100644 api/xstate/xstate.providedactor.id.md create mode 100644 api/xstate/xstate.providedactor.logic.md create mode 100644 api/xstate/xstate.providedactor.md create mode 100644 api/xstate/xstate.providedactor.src.md create mode 100644 api/xstate/xstate.pure.md create mode 100644 api/xstate/xstate.pureaction._out_taction.md create mode 100644 api/xstate/xstate.pureaction._out_tactor.md create mode 100644 api/xstate/xstate.pureaction._out_tdelay.md create mode 100644 api/xstate/xstate.pureaction._out_tevent.md create mode 100644 api/xstate/xstate.pureaction._out_tguard.md create mode 100644 api/xstate/xstate.pureaction.md create mode 100644 api/xstate/xstate.raise.md create mode 100644 api/xstate/xstate.raiseaction._out_tdelay.md create mode 100644 api/xstate/xstate.raiseaction._out_tevent.md create mode 100644 api/xstate/xstate.raiseaction.md create mode 100644 api/xstate/xstate.raiseactionoptions.delay.md create mode 100644 api/xstate/xstate.raiseactionoptions.id.md create mode 100644 api/xstate/xstate.raiseactionoptions.md create mode 100644 api/xstate/xstate.raiseactionparams.event.md create mode 100644 api/xstate/xstate.raiseactionparams.md create mode 100644 api/xstate/xstate.resolvedtypegenmeta.md create mode 100644 api/xstate/xstate.resolvedtypegenmeta.resolved.md create mode 100644 api/xstate/xstate.resolvetypegenmeta.___xstate_typegen_.md create mode 100644 api/xstate/xstate.resolvetypegenmeta.md create mode 100644 api/xstate/xstate.resolvetypegenmeta.resolved.md create mode 100644 api/xstate/xstate.sendexpr.md create mode 100644 api/xstate/xstate.sendparent.md create mode 100644 api/xstate/xstate.sendto.md create mode 100644 api/xstate/xstate.sendtoaction._out_tdelay.md create mode 100644 api/xstate/xstate.sendtoaction.md create mode 100644 api/xstate/xstate.sendtoactionoptions.md create mode 100644 api/xstate/xstate.sendtoactionparams.event.md create mode 100644 api/xstate/xstate.sendtoactionparams.md create mode 100644 api/xstate/xstate.simpleorstatenodeconfig.md create mode 100644 api/xstate/xstate.simulatedclock.cleartimeout.md create mode 100644 api/xstate/xstate.simulatedclock.increment.md create mode 100644 api/xstate/xstate.simulatedclock.md create mode 100644 api/xstate/xstate.simulatedclock.now.md create mode 100644 api/xstate/xstate.simulatedclock.set.md create mode 100644 api/xstate/xstate.simulatedclock.settimeout.md create mode 100644 api/xstate/xstate.simulatedclock.start.md create mode 100644 api/xstate/xstate.singleorarray.md create mode 100644 api/xstate/xstate.snapshot.md create mode 100644 api/xstate/xstate.snapshotevent.md create mode 100644 api/xstate/xstate.snapshotevent.snapshot.md create mode 100644 api/xstate/xstate.snapshotevent.type.md create mode 100644 api/xstate/xstate.snapshotfrom.md create mode 100644 api/xstate/xstate.spawner.md create mode 100644 api/xstate/xstate.specialtargets.md create mode 100644 api/xstate/xstate.state._constructor_.md create mode 100644 api/xstate/xstate.state.can.md create mode 100644 api/xstate/xstate.state.children.md create mode 100644 api/xstate/xstate.state.configuration.md create mode 100644 api/xstate/xstate.state.context.md create mode 100644 api/xstate/xstate.state.error.md create mode 100644 api/xstate/xstate.state.from.md create mode 100644 api/xstate/xstate.state.hastag.md create mode 100644 api/xstate/xstate.state.historyvalue.md create mode 100644 api/xstate/xstate.state.machine.md create mode 100644 api/xstate/xstate.state.matches.md create mode 100644 api/xstate/xstate.state.md create mode 100644 api/xstate/xstate.state.meta.md create mode 100644 api/xstate/xstate.state.nextevents.md create mode 100644 api/xstate/xstate.state.status.md create mode 100644 api/xstate/xstate.state.tags.md create mode 100644 api/xstate/xstate.state.tojson.md create mode 100644 api/xstate/xstate.state.tostrings.md create mode 100644 api/xstate/xstate.state.value.md create mode 100644 api/xstate/xstate.stateconfig.children.md create mode 100644 api/xstate/xstate.stateconfig.configuration.md create mode 100644 api/xstate/xstate.stateconfig.context.md create mode 100644 api/xstate/xstate.stateconfig.error.md create mode 100644 api/xstate/xstate.stateconfig.historyvalue.md create mode 100644 api/xstate/xstate.stateconfig.machine.md create mode 100644 api/xstate/xstate.stateconfig.md create mode 100644 api/xstate/xstate.stateconfig.meta.md create mode 100644 api/xstate/xstate.stateconfig.output.md create mode 100644 api/xstate/xstate.stateconfig.status.md create mode 100644 api/xstate/xstate.stateconfig.tags.md create mode 100644 api/xstate/xstate.stateconfig.value.md create mode 100644 api/xstate/xstate.statefrom.md create mode 100644 api/xstate/xstate.statein.md create mode 100644 api/xstate/xstate.statekey.md create mode 100644 api/xstate/xstate.statelike.context.md create mode 100644 api/xstate/xstate.statelike.event.md create mode 100644 api/xstate/xstate.statelike.md create mode 100644 api/xstate/xstate.statelike.value.md create mode 100644 api/xstate/xstate.statemachine.__taction.md create mode 100644 api/xstate/xstate.statemachine.__tactor.md create mode 100644 api/xstate/xstate.statemachine.__tcontext.md create mode 100644 api/xstate/xstate.statemachine.__tdelay.md create mode 100644 api/xstate/xstate.statemachine.__tevent.md create mode 100644 api/xstate/xstate.statemachine.__tguard.md create mode 100644 api/xstate/xstate.statemachine.__tinput.md create mode 100644 api/xstate/xstate.statemachine.__toutput.md create mode 100644 api/xstate/xstate.statemachine.__tresolvedtypesmeta.md create mode 100644 api/xstate/xstate.statemachine.__ttag.md create mode 100644 api/xstate/xstate.statemachine.__xstatenode.md create mode 100644 api/xstate/xstate.statemachine._constructor_.md create mode 100644 api/xstate/xstate.statemachine.config.md create mode 100644 api/xstate/xstate.statemachine.createstate.md create mode 100644 api/xstate/xstate.statemachine.definition.md create mode 100644 api/xstate/xstate.statemachine.events.md create mode 100644 api/xstate/xstate.statemachine.getinitialstate.md create mode 100644 api/xstate/xstate.statemachine.getpersistedstate.md create mode 100644 api/xstate/xstate.statemachine.getstatenodebyid.md create mode 100644 api/xstate/xstate.statemachine.gettransitiondata.md create mode 100644 api/xstate/xstate.statemachine.id.md create mode 100644 api/xstate/xstate.statemachine.idmap.md create mode 100644 api/xstate/xstate.statemachine.implementations.md create mode 100644 api/xstate/xstate.statemachine.md create mode 100644 api/xstate/xstate.statemachine.microstep.md create mode 100644 api/xstate/xstate.statemachine.provide.md create mode 100644 api/xstate/xstate.statemachine.resolvestate.md create mode 100644 api/xstate/xstate.statemachine.resolvestatevalue.md create mode 100644 api/xstate/xstate.statemachine.restorestate.md create mode 100644 api/xstate/xstate.statemachine.root.md create mode 100644 api/xstate/xstate.statemachine.start.md create mode 100644 api/xstate/xstate.statemachine.states.md create mode 100644 api/xstate/xstate.statemachine.tojson.md create mode 100644 api/xstate/xstate.statemachine.transition.md create mode 100644 api/xstate/xstate.statemachine.types.md create mode 100644 api/xstate/xstate.statemachine.version.md create mode 100644 api/xstate/xstate.statemachinedefinition.md create mode 100644 api/xstate/xstate.statenode._constructor_.md create mode 100644 api/xstate/xstate.statenode._initialize.md create mode 100644 api/xstate/xstate.statenode.after.md create mode 100644 api/xstate/xstate.statenode.always.md create mode 100644 api/xstate/xstate.statenode.config.md create mode 100644 api/xstate/xstate.statenode.definition.md create mode 100644 api/xstate/xstate.statenode.description.md create mode 100644 api/xstate/xstate.statenode.entry.md create mode 100644 api/xstate/xstate.statenode.events.md create mode 100644 api/xstate/xstate.statenode.exit.md create mode 100644 api/xstate/xstate.statenode.history.md create mode 100644 api/xstate/xstate.statenode.id.md create mode 100644 api/xstate/xstate.statenode.initial.md create mode 100644 api/xstate/xstate.statenode.invoke.md create mode 100644 api/xstate/xstate.statenode.key.md create mode 100644 api/xstate/xstate.statenode.machine.md create mode 100644 api/xstate/xstate.statenode.md create mode 100644 api/xstate/xstate.statenode.meta.md create mode 100644 api/xstate/xstate.statenode.next.md create mode 100644 api/xstate/xstate.statenode.on.md create mode 100644 api/xstate/xstate.statenode.order.md create mode 100644 api/xstate/xstate.statenode.output.md create mode 100644 api/xstate/xstate.statenode.ownevents.md create mode 100644 api/xstate/xstate.statenode.parent.md create mode 100644 api/xstate/xstate.statenode.path.md create mode 100644 api/xstate/xstate.statenode.states.md create mode 100644 api/xstate/xstate.statenode.tags.md create mode 100644 api/xstate/xstate.statenode.tojson.md create mode 100644 api/xstate/xstate.statenode.transitions.md create mode 100644 api/xstate/xstate.statenode.type.md create mode 100644 api/xstate/xstate.statenodeconfig.after.md create mode 100644 api/xstate/xstate.statenodeconfig.always.md create mode 100644 api/xstate/xstate.statenodeconfig.description.md create mode 100644 api/xstate/xstate.statenodeconfig.entry.md create mode 100644 api/xstate/xstate.statenodeconfig.exit.md create mode 100644 api/xstate/xstate.statenodeconfig.history.md create mode 100644 api/xstate/xstate.statenodeconfig.id.md create mode 100644 api/xstate/xstate.statenodeconfig.initial.md create mode 100644 api/xstate/xstate.statenodeconfig.invoke.md create mode 100644 api/xstate/xstate.statenodeconfig.md create mode 100644 api/xstate/xstate.statenodeconfig.meta.md create mode 100644 api/xstate/xstate.statenodeconfig.on.md create mode 100644 api/xstate/xstate.statenodeconfig.ondone.md create mode 100644 api/xstate/xstate.statenodeconfig.order.md create mode 100644 api/xstate/xstate.statenodeconfig.output.md create mode 100644 api/xstate/xstate.statenodeconfig.states.md create mode 100644 api/xstate/xstate.statenodeconfig.tags.md create mode 100644 api/xstate/xstate.statenodeconfig.target.md create mode 100644 api/xstate/xstate.statenodeconfig.type.md create mode 100644 api/xstate/xstate.statenodedefinition.description.md create mode 100644 api/xstate/xstate.statenodedefinition.entry.md create mode 100644 api/xstate/xstate.statenodedefinition.exit.md create mode 100644 api/xstate/xstate.statenodedefinition.history.md create mode 100644 api/xstate/xstate.statenodedefinition.id.md create mode 100644 api/xstate/xstate.statenodedefinition.initial.md create mode 100644 api/xstate/xstate.statenodedefinition.invoke.md create mode 100644 api/xstate/xstate.statenodedefinition.key.md create mode 100644 api/xstate/xstate.statenodedefinition.md create mode 100644 api/xstate/xstate.statenodedefinition.meta.md create mode 100644 api/xstate/xstate.statenodedefinition.on.md create mode 100644 api/xstate/xstate.statenodedefinition.order.md create mode 100644 api/xstate/xstate.statenodedefinition.output.md create mode 100644 api/xstate/xstate.statenodedefinition.states.md create mode 100644 api/xstate/xstate.statenodedefinition.tags.md create mode 100644 api/xstate/xstate.statenodedefinition.transitions.md create mode 100644 api/xstate/xstate.statenodedefinition.type.md create mode 100644 api/xstate/xstate.statenodedefinition.version.md create mode 100644 api/xstate/xstate.statenodesconfig.md create mode 100644 api/xstate/xstate.statesconfig.md create mode 100644 api/xstate/xstate.statesdefinition.md create mode 100644 api/xstate/xstate.statetypes.md create mode 100644 api/xstate/xstate.statevalue.md create mode 100644 api/xstate/xstate.statevaluefrom.md create mode 100644 api/xstate/xstate.statevaluemap.md create mode 100644 api/xstate/xstate.stop_2.md create mode 100644 api/xstate/xstate.stopaction.md create mode 100644 api/xstate/xstate.subscribable.md create mode 100644 api/xstate/xstate.subscribable.subscribe.md create mode 100644 api/xstate/xstate.subscribable.subscribe_1.md create mode 100644 api/xstate/xstate.subscription.md create mode 100644 api/xstate/xstate.subscription.unsubscribe.md create mode 100644 api/xstate/xstate.tagsfrom.md create mode 100644 api/xstate/xstate.todo.md create mode 100644 api/xstate/xstate.toobserver.md create mode 100644 api/xstate/xstate.transitionactorlogic.md create mode 100644 api/xstate/xstate.transitionconfig.actions.md create mode 100644 api/xstate/xstate.transitionconfig.description.md create mode 100644 api/xstate/xstate.transitionconfig.guard.md create mode 100644 api/xstate/xstate.transitionconfig.md create mode 100644 api/xstate/xstate.transitionconfig.meta.md create mode 100644 api/xstate/xstate.transitionconfig.reenter.md create mode 100644 api/xstate/xstate.transitionconfig.target.md create mode 100644 api/xstate/xstate.transitionconfigortarget.md create mode 100644 api/xstate/xstate.transitionconfigtarget.md create mode 100644 api/xstate/xstate.transitiondefinition.actions.md create mode 100644 api/xstate/xstate.transitiondefinition.eventtype.md create mode 100644 api/xstate/xstate.transitiondefinition.guard.md create mode 100644 api/xstate/xstate.transitiondefinition.md create mode 100644 api/xstate/xstate.transitiondefinition.reenter.md create mode 100644 api/xstate/xstate.transitiondefinition.source.md create mode 100644 api/xstate/xstate.transitiondefinition.target.md create mode 100644 api/xstate/xstate.transitiondefinition.tojson.md create mode 100644 api/xstate/xstate.transitiondefinitionmap.md create mode 100644 api/xstate/xstate.transitions.md create mode 100644 api/xstate/xstate.transitionsconfig.md create mode 100644 api/xstate/xstate.transitionsnapshot.md create mode 100644 api/xstate/xstate.transitiontarget.md create mode 100644 api/xstate/xstate.typegenconstraint.md create mode 100644 api/xstate/xstate.typegendisabled.___xstate_typegen_.md create mode 100644 api/xstate/xstate.typegendisabled.md create mode 100644 api/xstate/xstate.typegenenabled.___xstate_typegen_.md create mode 100644 api/xstate/xstate.typegenenabled.md create mode 100644 api/xstate/xstate.typegenmeta.eventscausingactions.md create mode 100644 api/xstate/xstate.typegenmeta.eventscausingactors.md create mode 100644 api/xstate/xstate.typegenmeta.eventscausingdelays.md create mode 100644 api/xstate/xstate.typegenmeta.eventscausingguards.md create mode 100644 api/xstate/xstate.typegenmeta.internalevents.md create mode 100644 api/xstate/xstate.typegenmeta.invokesrcnamemap.md create mode 100644 api/xstate/xstate.typegenmeta.matchesstates.md create mode 100644 api/xstate/xstate.typegenmeta.md create mode 100644 api/xstate/xstate.typegenmeta.missingimplementations.md create mode 100644 api/xstate/xstate.typegenmeta.tags.md create mode 100644 api/xstate/xstate.unifiedarg.context.md create mode 100644 api/xstate/xstate.unifiedarg.event.md create mode 100644 api/xstate/xstate.unifiedarg.md create mode 100644 api/xstate/xstate.unifiedarg.self.md create mode 100644 api/xstate/xstate.unifiedarg.system.md create mode 100644 api/xstate/xstate.unknownaction.md create mode 100644 api/xstate/xstate.values.md create mode 100644 api/xstate/xstate.waitfor.md create mode 100644 api/xstate/xstate.withdynamicparams.md diff --git a/api/xstate/index.md b/api/xstate/index.md new file mode 100644 index 000000000..738da53f9 --- /dev/null +++ b/api/xstate/index.md @@ -0,0 +1,259 @@ +--- +title: "xstate" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## xstate package + +## Classes + +| Class | Description | +| --- | --- | +| [Actor](./xstate.actor.md) | | +| [SimulatedClock](./xstate.simulatedclock.md) | | +| [State](./xstate.state.md) | | +| [StateMachine](./xstate.statemachine.md) | | +| [StateNode](./xstate.statenode.md) | | + +## Enumerations + +| Enumeration | Description | +| --- | --- | +| [ActorStatus](./xstate.actorstatus.md) | | +| [SpecialTargets](./xstate.specialtargets.md) | | + +## Functions + +| Function | Description | +| --- | --- | +| [and(guards)](./xstate.and.md) | | +| [assign(assignment)](./xstate.assign.md) | Updates the current context of the machine. | +| [cancel(sendId)](./xstate.cancel.md) | Cancels an in-flight send(...) action. A canceled sent action will not be executed, nor will its event be sent, unless it has already been sent (e.g., if cancel(...) is called after the send(...) action's delay). | +| [choose(branches)](./xstate.choose.md) | | +| [createActor(machine, options)](./xstate.createactor.md) | Creates a new ActorRef instance for the given machine with the provided options, if any. | +| [createActor(logic, options)](./xstate.createactor_1.md) | | +| [createEmptyActor()](./xstate.createemptyactor.md) | | +| [createMachine(config, implementations)](./xstate.createmachine.md) | | +| [escalate(errorData, options)](./xstate.escalate.md) | Escalates an error by sending it as an event to this machine's parent. | +| [forwardTo(target, options)](./xstate.forwardto.md) | Forwards (sends) an event to a specified service. | +| [fromCallback(invokeCallback)](./xstate.fromcallback.md) | | +| [fromEventObservable(lazyObservable)](./xstate.fromeventobservable.md) | Creates event observable logic that listens to an observable that delivers event objects. | +| [fromObservable(observableCreator)](./xstate.fromobservable.md) | | +| [fromPromise(promiseCreator)](./xstate.frompromise.md) | | +| [fromTransition(transition, initialContext)](./xstate.fromtransition.md) |

Returns actor logic from a transition function and its initial state.

A transition function is a function that takes the current state and an event and returns the next state.

| +| [getStateNodes(stateNode, state)](./xstate.getstatenodes.md) | Returns the state nodes represented by the current state value. | +| [log(value, label)](./xstate.log.md) | | +| [mapState(stateMap, stateId)](./xstate.mapstate.md) | | +| [matchesState(parentStateId, childStateId)](./xstate.matchesstate.md) | | +| [not(guard)](./xstate.not.md) | | +| [or(guards)](./xstate.or.md) | | +| [pathToStateValue(statePath)](./xstate.pathtostatevalue.md) | | +| [pure(getActions)](./xstate.pure.md) | | +| [raise(eventOrExpr, options)](./xstate.raise.md) | Raises an event. This places the event in the internal event queue, so that the event is immediately consumed by the machine in the current step. | +| [sendParent(event, options)](./xstate.sendparent.md) | Sends an event to this machine's parent. | +| [sendTo(to, eventOrExpr, options)](./xstate.sendto.md) | Sends an event to an actor. | +| [stateIn(stateValue)](./xstate.statein.md) | | +| [stop\_2(actorRef)](./xstate.stop_2.md) | Stops an actor. | +| [toObserver(nextHandler, errorHandler, completionHandler)](./xstate.toobserver.md) | | +| [waitFor(actorRef, predicate, options)](./xstate.waitfor.md) | Subscribes to an actor ref and waits for its emitted value to satisfy a predicate, and then resolves with that value. Will throw if the desired state is not reached after a timeout (defaults to 10 seconds). | + +## Interfaces + +| Interface | Description | +| --- | --- | +| [ActionArgs](./xstate.actionargs.md) | | +| [ActorContext](./xstate.actorcontext.md) | | +| [ActorLike](./xstate.actorlike.md) | | +| [ActorLogic](./xstate.actorlogic.md) | | +| [ActorOptions](./xstate.actoroptions.md) | | +| [ActorRef](./xstate.actorref.md) | | +| [ActorSystem](./xstate.actorsystem.md) | | +| [ActorSystemInfo](./xstate.actorsysteminfo.md) | | +| [AnyEventObject](./xstate.anyeventobject.md) | | +| [AssignAction](./xstate.assignaction.md) | | +| [AssignArgs](./xstate.assignargs.md) | | +| [AtomicStateNodeConfig](./xstate.atomicstatenodeconfig.md) | | +| [BaseActorRef](./xstate.baseactorref.md) | | +| [CancelAction](./xstate.cancelaction.md) | | +| [ChooseAction](./xstate.chooseaction.md) | | +| [ChooseBranch](./xstate.choosebranch.md) | | +| [DelayedTransitionDefinition](./xstate.delayedtransitiondefinition.md) | | +| [DoneActorEvent](./xstate.doneactorevent.md) | | +| [DoneStateEvent](./xstate.donestateevent.md) | | +| [ErrorActorEvent](./xstate.erroractorevent.md) | | +| [EventObject](./xstate.eventobject.md) | The full definition of an event, with a string type. | +| [HistoryStateNode](./xstate.historystatenode.md) | | +| [HistoryStateNodeConfig](./xstate.historystatenodeconfig.md) | | +| [InitialTransitionConfig](./xstate.initialtransitionconfig.md) | | +| [InitialTransitionDefinition](./xstate.initialtransitiondefinition.md) | | +| [InspectedActorEvent](./xstate.inspectedactorevent.md) | | +| [InspectedEventEvent](./xstate.inspectedeventevent.md) | | +| [InspectedSnapshotEvent](./xstate.inspectedsnapshotevent.md) | | +| [InteropObservable](./xstate.interopobservable.md) | | +| [InteropSubscribable](./xstate.interopsubscribable.md) | | +| [InvokeDefinition](./xstate.invokedefinition.md) | | +| [LogAction](./xstate.logaction.md) | | +| [MachineImplementationsSimplified](./xstate.machineimplementationssimplified.md) | | +| [MachineTypes](./xstate.machinetypes.md) | | +| [MarkAllImplementationsAsProvided](./xstate.markallimplementationsasprovided.md) | | +| [ParameterizedObject](./xstate.parameterizedobject.md) | | +| [ProvidedActor](./xstate.providedactor.md) | | +| [PureAction](./xstate.pureaction.md) | | +| [RaiseAction](./xstate.raiseaction.md) | | +| [RaiseActionOptions](./xstate.raiseactionoptions.md) | | +| [RaiseActionParams](./xstate.raiseactionparams.md) | | +| [ResolvedTypegenMeta](./xstate.resolvedtypegenmeta.md) | | +| [ResolveTypegenMeta](./xstate.resolvetypegenmeta.md) | | +| [SendToAction](./xstate.sendtoaction.md) | | +| [SendToActionOptions](./xstate.sendtoactionoptions.md) | | +| [SendToActionParams](./xstate.sendtoactionparams.md) | | +| [SimulatedClock](./xstate.simulatedclock.md) | | +| [SnapshotEvent](./xstate.snapshotevent.md) | | +| [StateConfig](./xstate.stateconfig.md) | | +| [StateLike](./xstate.statelike.md) | | +| [StateMachineDefinition](./xstate.statemachinedefinition.md) | | +| [StateNodeConfig](./xstate.statenodeconfig.md) | | +| [StateNodeDefinition](./xstate.statenodedefinition.md) | | +| [StateValueMap](./xstate.statevaluemap.md) | | +| [StopAction](./xstate.stopaction.md) | | +| [Subscribable](./xstate.subscribable.md) | | +| [Subscription](./xstate.subscription.md) | | +| [TransitionConfig](./xstate.transitionconfig.md) | | +| [TransitionDefinition](./xstate.transitiondefinition.md) | | +| [TypegenDisabled](./xstate.typegendisabled.md) | | +| [TypegenEnabled](./xstate.typegenenabled.md) | | +| [TypegenMeta](./xstate.typegenmeta.md) | | +| [UnifiedArg](./xstate.unifiedarg.md) | | + +## Variables + +| Variable | Description | +| --- | --- | +| [interpret](./xstate.interpret.md) | Creates a new Interpreter instance for the given machine with the provided options, if any. | +| [InterpreterStatus](./xstate.interpreterstatus.md) | | + +## Type Aliases + +| Type Alias | Description | +| --- | --- | +| [\_\_ResolvedTypesMetaFrom](./xstate.__resolvedtypesmetafrom.md) | | +| [Action](./xstate.action.md) | | +| [ActionFunction](./xstate.actionfunction.md) | | +| [ActionFunctionMap](./xstate.actionfunctionmap.md) | | +| [Actions](./xstate.actions.md) | | +| [ActorLogicFrom](./xstate.actorlogicfrom.md) | | +| [ActorRefFrom](./xstate.actorreffrom.md) | | +| [AnyActor](./xstate.anyactor.md) | | +| [AnyActorContext](./xstate.anyactorcontext.md) | | +| [AnyActorLogic](./xstate.anyactorlogic.md) | | +| [AnyActorRef](./xstate.anyactorref.md) | | +| [AnyActorSystem](./xstate.anyactorsystem.md) | | +| [AnyFunction](./xstate.anyfunction.md) | | +| [AnyHistoryValue](./xstate.anyhistoryvalue.md) | | +| [AnyInterpreter](./xstate.anyinterpreter.md) | | +| [AnyInvokeConfig](./xstate.anyinvokeconfig.md) | | +| [AnyState](./xstate.anystate.md) | | +| [AnyStateConfig](./xstate.anystateconfig.md) | | +| [AnyStateMachine](./xstate.anystatemachine.md) | | +| [AnyStateNode](./xstate.anystatenode.md) | | +| [AnyStateNodeConfig](./xstate.anystatenodeconfig.md) | | +| [AnyStateNodeDefinition](./xstate.anystatenodedefinition.md) | | +| [AnyTransitionConfig](./xstate.anytransitionconfig.md) | | +| [AnyTransitionDefinition](./xstate.anytransitiondefinition.md) | | +| [AreAllImplementationsAssumedToBeProvided](./xstate.areallimplementationsassumedtobeprovided.md) | | +| [Assigner](./xstate.assigner.md) | | +| [CallbackActorLogic](./xstate.callbackactorlogic.md) | | +| [Cast](./xstate.cast.md) | | +| [Compute](./xstate.compute.md) | | +| [ContextFactory](./xstate.contextfactory.md) | | +| [ContextFrom](./xstate.contextfrom.md) | | +| [DelayConfig](./xstate.delayconfig.md) | | +| [DelayedTransitions](./xstate.delayedtransitions.md) | | +| [DelayExpr](./xstate.delayexpr.md) | | +| [DelayFunctionMap](./xstate.delayfunctionmap.md) | | +| [DevToolsAdapter](./xstate.devtoolsadapter.md) | | +| [Equals](./xstate.equals.md) | | +| [EventDescriptor](./xstate.eventdescriptor.md) | | +| [EventFrom](./xstate.eventfrom.md) | | +| [EventFromLogic](./xstate.eventfromlogic.md) | | +| [ExtractEvent](./xstate.extractevent.md) | | +| [HistoryValue](./xstate.historyvalue.md) | | +| [HomomorphicOmit](./xstate.homomorphicomit.md) | | +| [HomomorphicPick](./xstate.homomorphicpick.md) | | +| [IndexByProp](./xstate.indexbyprop.md) | | +| [IndexByType](./xstate.indexbytype.md) | | +| [InferEvent](./xstate.inferevent.md) | | +| [InputFrom](./xstate.inputfrom.md) | | +| [InspectionEvent](./xstate.inspectionevent.md) | | +| [InternalMachineImplementations](./xstate.internalmachineimplementations.md) | | +| [Interpreter](./xstate.interpreter.md) | | +| [InterpreterFrom](./xstate.interpreterfrom.md) | | +| [InvokeConfig](./xstate.invokeconfig.md) | | +| [IsAny](./xstate.isany.md) | | +| [IsLiteralString](./xstate.isliteralstring.md) | | +| [IsNever](./xstate.isnever.md) | | +| [Lazy](./xstate.lazy.md) | | +| [LogExpr](./xstate.logexpr.md) | | +| [LowInfer](./xstate.lowinfer.md) | | +| [MachineConfig](./xstate.machineconfig.md) | | +| [MachineContext](./xstate.machinecontext.md) | | +| [MachineImplementations](./xstate.machineimplementations.md) | | +| [MachineImplementationsFrom](./xstate.machineimplementationsfrom.md) | | +| [MachineSnapshot](./xstate.machinesnapshot.md) | | +| [Mapper](./xstate.mapper.md) | | +| [MaybeLazy](./xstate.maybelazy.md) | | +| [Merge](./xstate.merge.md) | | +| [MetaObject](./xstate.metaobject.md) | | +| [MissingImplementationsError](./xstate.missingimplementationserror.md) | | +| [NoInfer](./xstate.noinfer.md) | | +| [NonReducibleUnknown](./xstate.nonreducibleunknown.md) |

T | unknown reduces to unknown and that can be problematic when it comes to contextual typing. It especially is a problem when the union has a function member, like here:

+```ts +declare function test(cbOrVal: ((arg: number) => unknown) | unknown): void; +test((arg) => {}) // oops, implicit any +``` +

This type can be used to avoid this problem. This union represents the same value space as unknown.

| +| [NoRequiredParams](./xstate.norequiredparams.md) | | +| [ObservableActorLogic](./xstate.observableactorlogic.md) | | +| [Observer](./xstate.observer.md) | | +| [OutputFrom](./xstate.outputfrom.md) | | +| [PartialAssigner](./xstate.partialassigner.md) | | +| [PersistedMachineState](./xstate.persistedmachinestate.md) | | +| [PersistedStateFrom](./xstate.persistedstatefrom.md) | | +| [PromiseActorLogic](./xstate.promiseactorlogic.md) | | +| [Prop](./xstate.prop.md) | | +| [PropertyAssigner](./xstate.propertyassigner.md) | | +| [SendExpr](./xstate.sendexpr.md) | | +| [SimpleOrStateNodeConfig](./xstate.simpleorstatenodeconfig.md) | | +| [SingleOrArray](./xstate.singleorarray.md) | | +| [Snapshot](./xstate.snapshot.md) | | +| [SnapshotFrom](./xstate.snapshotfrom.md) | | +| [Spawner](./xstate.spawner.md) | | +| [StateFrom](./xstate.statefrom.md) | | +| [StateKey](./xstate.statekey.md) | | +| [StateNodesConfig](./xstate.statenodesconfig.md) | | +| [StatesConfig](./xstate.statesconfig.md) | | +| [StatesDefinition](./xstate.statesdefinition.md) | | +| [StateTypes](./xstate.statetypes.md) | | +| [StateValue](./xstate.statevalue.md) | The string or object representing the state value relative to the parent state node. | +| [StateValueFrom](./xstate.statevaluefrom.md) | | +| [TagsFrom](./xstate.tagsfrom.md) | | +| [TODO](./xstate.todo.md) | | +| [TransitionActorLogic](./xstate.transitionactorlogic.md) | | +| [TransitionConfigOrTarget](./xstate.transitionconfigortarget.md) | | +| [TransitionConfigTarget](./xstate.transitionconfigtarget.md) | | +| [TransitionDefinitionMap](./xstate.transitiondefinitionmap.md) | | +| [Transitions](./xstate.transitions.md) | | +| [TransitionsConfig](./xstate.transitionsconfig.md) | | +| [TransitionSnapshot](./xstate.transitionsnapshot.md) | | +| [TransitionTarget](./xstate.transitiontarget.md) | | +| [TypegenConstraint](./xstate.typegenconstraint.md) | | +| [UnknownAction](./xstate.unknownaction.md) | | +| [Values](./xstate.values.md) | | +| [WithDynamicParams](./xstate.withdynamicparams.md) | | + diff --git a/api/xstate/xstate.__resolvedtypesmetafrom.md b/api/xstate/xstate.__resolvedtypesmetafrom.md new file mode 100644 index 000000000..604875445 --- /dev/null +++ b/api/xstate/xstate.__resolvedtypesmetafrom.md @@ -0,0 +1,29 @@ +--- +title: "__ResolvedTypesMetaFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## \_\_ResolvedTypesMetaFrom type + +**Signature:** + +```typescript +export type __ResolvedTypesMetaFrom = T extends StateMachine ? TResolvedTypesMeta : never; +``` +**References:** [StateMachine](./xstate.statemachine.md) + diff --git a/api/xstate/xstate.action.md b/api/xstate/xstate.action.md new file mode 100644 index 000000000..2c46f1896 --- /dev/null +++ b/api/xstate/xstate.action.md @@ -0,0 +1,20 @@ +--- +title: "Action" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Action type + +**Signature:** + +```typescript +export type Action = NoRequiredParams | WithDynamicParams | ActionFunction; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [NoRequiredParams](./xstate.norequiredparams.md)<>, [WithDynamicParams](./xstate.withdynamicparams.md)<>, [ActionFunction](./xstate.actionfunction.md) + diff --git a/api/xstate/xstate.actionargs.action.md b/api/xstate/xstate.actionargs.action.md new file mode 100644 index 000000000..748467fba --- /dev/null +++ b/api/xstate/xstate.actionargs.action.md @@ -0,0 +1,18 @@ +--- +title: "action" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActionArgs.action property + +**Signature:** + +```typescript +action: TExpressionAction; +``` diff --git a/api/xstate/xstate.actionargs.md b/api/xstate/xstate.actionargs.md new file mode 100644 index 000000000..a58aa5684 --- /dev/null +++ b/api/xstate/xstate.actionargs.md @@ -0,0 +1,26 @@ +--- +title: "ActionArgs" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActionArgs interface + +**Signature:** + +```typescript +export interface ActionArgs extends UnifiedArg +``` +**Extends:** [UnifiedArg](./xstate.unifiedarg.md)<><TContext, TExpressionEvent, TEvent> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [action](./xstate.actionargs.action.md) | | TExpressionAction | | + diff --git a/api/xstate/xstate.actionfunction.md b/api/xstate/xstate.actionfunction.md new file mode 100644 index 000000000..0ae3783fa --- /dev/null +++ b/api/xstate/xstate.actionfunction.md @@ -0,0 +1,27 @@ +--- +title: "ActionFunction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActionFunction type + +**Signature:** + +```typescript +export type ActionFunction = { + (args: ActionArgs): void; + _out_TEvent?: TEvent; + _out_TActor?: TActor; + _out_TAction?: TAction; + _out_TGuard?: TGuard; + _out_TDelay?: TDelay; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ActionArgs](./xstate.actionargs.md) + diff --git a/api/xstate/xstate.actionfunctionmap.md b/api/xstate/xstate.actionfunctionmap.md new file mode 100644 index 000000000..660f71db1 --- /dev/null +++ b/api/xstate/xstate.actionfunctionmap.md @@ -0,0 +1,24 @@ +--- +title: "ActionFunctionMap" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActionFunctionMap type + +**Signature:** + +```typescript +export type ActionFunctionMap = { + [K in TAction['type']]?: ActionFunction; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ActionFunction](./xstate.actionfunction.md) + diff --git a/api/xstate/xstate.actions.md b/api/xstate/xstate.actions.md new file mode 100644 index 000000000..b6f5b4dbe --- /dev/null +++ b/api/xstate/xstate.actions.md @@ -0,0 +1,20 @@ +--- +title: "Actions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actions type + +**Signature:** + +```typescript +export type Actions = SingleOrArray>; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [SingleOrArray](./xstate.singleorarray.md)<>, [Action](./xstate.action.md) + diff --git a/api/xstate/xstate.actor._constructor_.md b/api/xstate/xstate.actor._constructor_.md new file mode 100644 index 000000000..6cab74e13 --- /dev/null +++ b/api/xstate/xstate.actor._constructor_.md @@ -0,0 +1,28 @@ +--- +title: "(constructor)" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.(constructor) + +Creates a new actor instance for the given logic with the provided options, if any. + +**Signature:** + +```typescript +constructor(logic: TLogic, options?: ActorOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| logic | TLogic | The logic to create an actor from | +| options | [ActorOptions](./xstate.actoroptions.md)<><TLogic> | _(Optional)_ Actor options | + diff --git a/api/xstate/xstate.actor._parent.md b/api/xstate/xstate.actor._parent.md new file mode 100644 index 000000000..fa1017276 --- /dev/null +++ b/api/xstate/xstate.actor._parent.md @@ -0,0 +1,18 @@ +--- +title: "_parent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.\_parent property + +**Signature:** + +```typescript +_parent?: ActorRef; +``` diff --git a/api/xstate/xstate.actor._symbolobservable_.md b/api/xstate/xstate.actor._symbolobservable_.md new file mode 100644 index 000000000..7650cb306 --- /dev/null +++ b/api/xstate/xstate.actor._symbolobservable_.md @@ -0,0 +1,22 @@ +--- +title: "[symbolObservable]" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.\[symbolObservable\]() method + +**Signature:** + +```typescript +[symbolObservable](): InteropSubscribable>; +``` +**Returns:** + +[InteropSubscribable](./xstate.interopsubscribable.md)<><[SnapshotFrom](./xstate.snapshotfrom.md)<><TLogic>> + diff --git a/api/xstate/xstate.actor.cancel.md b/api/xstate/xstate.actor.cancel.md new file mode 100644 index 000000000..1ff2a30b6 --- /dev/null +++ b/api/xstate/xstate.actor.cancel.md @@ -0,0 +1,29 @@ +--- +title: "cancel" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.cancel() method + +**Signature:** + +```typescript +cancel(sendId: string | number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sendId | string \| number | | + +**Returns:** + +void + diff --git a/api/xstate/xstate.actor.clock.md b/api/xstate/xstate.actor.clock.md new file mode 100644 index 000000000..7935f7396 --- /dev/null +++ b/api/xstate/xstate.actor.clock.md @@ -0,0 +1,20 @@ +--- +title: "clock" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.clock property + +The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. + +**Signature:** + +```typescript +clock: Clock; +``` diff --git a/api/xstate/xstate.actor.delaysend.md b/api/xstate/xstate.actor.delaysend.md new file mode 100644 index 000000000..c51082164 --- /dev/null +++ b/api/xstate/xstate.actor.delaysend.md @@ -0,0 +1,34 @@ +--- +title: "delaySend" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.delaySend() method + +**Signature:** + +```typescript +delaySend(params: { + event: EventObject; + id: string | undefined; + delay: number; + to?: AnyActorRef; + }): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| params | { event: [EventObject](./xstate.eventobject.md)<>; id: string \| undefined; delay: number; to?: [AnyActorRef](./xstate.anyactorref.md)<>; } | | + +**Returns:** + +void + diff --git a/api/xstate/xstate.actor.getpersistedstate.md b/api/xstate/xstate.actor.getpersistedstate.md new file mode 100644 index 000000000..ad1bd7cd6 --- /dev/null +++ b/api/xstate/xstate.actor.getpersistedstate.md @@ -0,0 +1,22 @@ +--- +title: "getPersistedState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.getPersistedState() method + +**Signature:** + +```typescript +getPersistedState(): PersistedStateFrom | undefined; +``` +**Returns:** + +[PersistedStateFrom](./xstate.persistedstatefrom.md)<><TLogic> \| undefined + diff --git a/api/xstate/xstate.actor.getsnapshot.md b/api/xstate/xstate.actor.getsnapshot.md new file mode 100644 index 000000000..60ae9b1d3 --- /dev/null +++ b/api/xstate/xstate.actor.getsnapshot.md @@ -0,0 +1,22 @@ +--- +title: "getSnapshot" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.getSnapshot() method + +**Signature:** + +```typescript +getSnapshot(): SnapshotFrom; +``` +**Returns:** + +[SnapshotFrom](./xstate.snapshotfrom.md)<><TLogic> + diff --git a/api/xstate/xstate.actor.id.md b/api/xstate/xstate.actor.id.md new file mode 100644 index 000000000..d57f0ca71 --- /dev/null +++ b/api/xstate/xstate.actor.id.md @@ -0,0 +1,20 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.id property + +The unique identifier for this actor relative to its parent. + +**Signature:** + +```typescript +id: string; +``` diff --git a/api/xstate/xstate.actor.logic.md b/api/xstate/xstate.actor.logic.md new file mode 100644 index 000000000..857896fb1 --- /dev/null +++ b/api/xstate/xstate.actor.logic.md @@ -0,0 +1,18 @@ +--- +title: "logic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.logic property + +**Signature:** + +```typescript +logic: TLogic; +``` diff --git a/api/xstate/xstate.actor.md b/api/xstate/xstate.actor.md new file mode 100644 index 000000000..948ac627f --- /dev/null +++ b/api/xstate/xstate.actor.md @@ -0,0 +1,57 @@ +--- +title: "Actor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor class + +**Signature:** + +```typescript +export declare class Actor implements ActorRef, SnapshotFrom> +``` +**Implements:** [ActorRef](./xstate.actorref.md)<><[EventFromLogic](./xstate.eventfromlogic.md)<><TLogic>, [SnapshotFrom](./xstate.snapshotfrom.md)<><TLogic>> + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(logic, options)](./xstate.actor._constructor_.md) | | Creates a new actor instance for the given logic with the provided options, if any. | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_parent?](./xstate.actor._parent.md) | | [ActorRef](./xstate.actorref.md)<><any, any> | _(Optional)_ | +| [clock](./xstate.actor.clock.md) | | Clock | The clock that is responsible for setting and clearing timeouts, such as delayed events and transitions. | +| [id](./xstate.actor.id.md) | | string | The unique identifier for this actor relative to its parent. | +| [logic](./xstate.actor.logic.md) | | TLogic | | +| [options](./xstate.actor.options.md) | | Readonly<[ActorOptions](./xstate.actoroptions.md)<><TLogic>> | | +| [ref](./xstate.actor.ref.md) | | [ActorRef](./xstate.actorref.md)<><[EventFromLogic](./xstate.eventfromlogic.md)<><TLogic>, [SnapshotFrom](./xstate.snapshotfrom.md)<><TLogic>> | | +| [sessionId](./xstate.actor.sessionid.md) | | string | The globally unique process ID for this invocation. | +| [src?](./xstate.actor.src.md) | | string | _(Optional)_ | +| [status](./xstate.actor.status.md) | | [ActorStatus](./xstate.actorstatus.md) | Whether the service is started. | +| [system](./xstate.actor.system.md) | | [ActorSystem](./xstate.actorsystem.md)<><any> | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\[symbolObservable\]()](./xstate.actor._symbolobservable_.md) | | | +| [cancel(sendId)](./xstate.actor.cancel.md) | | | +| [delaySend(params)](./xstate.actor.delaysend.md) | | | +| [getPersistedState()](./xstate.actor.getpersistedstate.md) | | | +| [getSnapshot()](./xstate.actor.getsnapshot.md) | | | +| [send(event)](./xstate.actor.send.md) | | Sends an event to the running Actor to trigger a transition. | +| [start()](./xstate.actor.start.md) | | Starts the Actor from the initial state | +| [stop()](./xstate.actor.stop.md) | | Stops the Actor and unsubscribe all listeners. | +| [subscribe(observer)](./xstate.actor.subscribe.md) | | | +| [subscribe(nextListener, errorListener, completeListener)](./xstate.actor.subscribe_1.md) | | | +| [toJSON()](./xstate.actor.tojson.md) | | | + diff --git a/api/xstate/xstate.actor.options.md b/api/xstate/xstate.actor.options.md new file mode 100644 index 000000000..a4f11e5c6 --- /dev/null +++ b/api/xstate/xstate.actor.options.md @@ -0,0 +1,18 @@ +--- +title: "options" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.options property + +**Signature:** + +```typescript +options: Readonly>; +``` diff --git a/api/xstate/xstate.actor.ref.md b/api/xstate/xstate.actor.ref.md new file mode 100644 index 000000000..7dcb62be1 --- /dev/null +++ b/api/xstate/xstate.actor.ref.md @@ -0,0 +1,18 @@ +--- +title: "ref" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.ref property + +**Signature:** + +```typescript +ref: ActorRef, SnapshotFrom>; +``` diff --git a/api/xstate/xstate.actor.send.md b/api/xstate/xstate.actor.send.md new file mode 100644 index 000000000..096e16108 --- /dev/null +++ b/api/xstate/xstate.actor.send.md @@ -0,0 +1,31 @@ +--- +title: "send" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.send() method + +Sends an event to the running Actor to trigger a transition. + +**Signature:** + +```typescript +send(event: EventFromLogic): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | [EventFromLogic](./xstate.eventfromlogic.md)<><TLogic> | The event to send | + +**Returns:** + +void + diff --git a/api/xstate/xstate.actor.sessionid.md b/api/xstate/xstate.actor.sessionid.md new file mode 100644 index 000000000..d46223445 --- /dev/null +++ b/api/xstate/xstate.actor.sessionid.md @@ -0,0 +1,20 @@ +--- +title: "sessionId" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.sessionId property + +The globally unique process ID for this invocation. + +**Signature:** + +```typescript +sessionId: string; +``` diff --git a/api/xstate/xstate.actor.src.md b/api/xstate/xstate.actor.src.md new file mode 100644 index 000000000..8322288ba --- /dev/null +++ b/api/xstate/xstate.actor.src.md @@ -0,0 +1,18 @@ +--- +title: "src" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.src property + +**Signature:** + +```typescript +src?: string; +``` diff --git a/api/xstate/xstate.actor.start.md b/api/xstate/xstate.actor.start.md new file mode 100644 index 000000000..819e3c604 --- /dev/null +++ b/api/xstate/xstate.actor.start.md @@ -0,0 +1,24 @@ +--- +title: "start" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.start() method + +Starts the Actor from the initial state + +**Signature:** + +```typescript +start(): this; +``` +**Returns:** + +this + diff --git a/api/xstate/xstate.actor.status.md b/api/xstate/xstate.actor.status.md new file mode 100644 index 000000000..764d5d42a --- /dev/null +++ b/api/xstate/xstate.actor.status.md @@ -0,0 +1,20 @@ +--- +title: "status" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.status property + +Whether the service is started. + +**Signature:** + +```typescript +status: ActorStatus; +``` diff --git a/api/xstate/xstate.actor.stop.md b/api/xstate/xstate.actor.stop.md new file mode 100644 index 000000000..6104764d4 --- /dev/null +++ b/api/xstate/xstate.actor.stop.md @@ -0,0 +1,24 @@ +--- +title: "stop" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.stop() method + +Stops the Actor and unsubscribe all listeners. + +**Signature:** + +```typescript +stop(): this; +``` +**Returns:** + +this + diff --git a/api/xstate/xstate.actor.subscribe.md b/api/xstate/xstate.actor.subscribe.md new file mode 100644 index 000000000..e1610e6f0 --- /dev/null +++ b/api/xstate/xstate.actor.subscribe.md @@ -0,0 +1,29 @@ +--- +title: "subscribe" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.subscribe() method + +**Signature:** + +```typescript +subscribe(observer: Observer>): Subscription; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| observer | [Observer](./xstate.observer.md)<><[SnapshotFrom](./xstate.snapshotfrom.md)<><TLogic>> | | + +**Returns:** + +[Subscription](./xstate.subscription.md) + diff --git a/api/xstate/xstate.actor.subscribe_1.md b/api/xstate/xstate.actor.subscribe_1.md new file mode 100644 index 000000000..29d8815c8 --- /dev/null +++ b/api/xstate/xstate.actor.subscribe_1.md @@ -0,0 +1,31 @@ +--- +title: "subscribe" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.subscribe() method + +**Signature:** + +```typescript +subscribe(nextListener?: (state: SnapshotFrom) => void, errorListener?: (error: any) => void, completeListener?: () => void): Subscription; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| nextListener | (state: [SnapshotFrom](./xstate.snapshotfrom.md)<><TLogic>) => void | _(Optional)_ | +| errorListener | (error: any) => void | _(Optional)_ | +| completeListener | () => void | _(Optional)_ | + +**Returns:** + +[Subscription](./xstate.subscription.md) + diff --git a/api/xstate/xstate.actor.system.md b/api/xstate/xstate.actor.system.md new file mode 100644 index 000000000..c5fa8973f --- /dev/null +++ b/api/xstate/xstate.actor.system.md @@ -0,0 +1,18 @@ +--- +title: "system" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.system property + +**Signature:** + +```typescript +system: ActorSystem; +``` diff --git a/api/xstate/xstate.actor.tojson.md b/api/xstate/xstate.actor.tojson.md new file mode 100644 index 000000000..f0f934c38 --- /dev/null +++ b/api/xstate/xstate.actor.tojson.md @@ -0,0 +1,25 @@ +--- +title: "toJSON" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Actor.toJSON() method + +**Signature:** + +```typescript +toJSON(): { + xstate$$type: number; + id: string; + }; +``` +**Returns:** + +{ xstate$$type: number; id: string; } + diff --git a/api/xstate/xstate.actorcontext.defer.md b/api/xstate/xstate.actorcontext.defer.md new file mode 100644 index 000000000..5259afdf0 --- /dev/null +++ b/api/xstate/xstate.actorcontext.defer.md @@ -0,0 +1,18 @@ +--- +title: "defer" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorContext.defer property + +**Signature:** + +```typescript +defer: (fn: () => void) => void; +``` diff --git a/api/xstate/xstate.actorcontext.id.md b/api/xstate/xstate.actorcontext.id.md new file mode 100644 index 000000000..e906242cf --- /dev/null +++ b/api/xstate/xstate.actorcontext.id.md @@ -0,0 +1,18 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorContext.id property + +**Signature:** + +```typescript +id: string; +``` diff --git a/api/xstate/xstate.actorcontext.logger.md b/api/xstate/xstate.actorcontext.logger.md new file mode 100644 index 000000000..9c97e6f93 --- /dev/null +++ b/api/xstate/xstate.actorcontext.logger.md @@ -0,0 +1,18 @@ +--- +title: "logger" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorContext.logger property + +**Signature:** + +```typescript +logger: (...args: any[]) => void; +``` diff --git a/api/xstate/xstate.actorcontext.md b/api/xstate/xstate.actorcontext.md new file mode 100644 index 000000000..f00b77346 --- /dev/null +++ b/api/xstate/xstate.actorcontext.md @@ -0,0 +1,31 @@ +--- +title: "ActorContext" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorContext interface + +**Signature:** + +```typescript +export interface ActorContext, TEvent extends EventObject, TSystem extends ActorSystem = ActorSystem> +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [defer](./xstate.actorcontext.defer.md) | | (fn: () => void) => void | | +| [id](./xstate.actorcontext.id.md) | | string | | +| [logger](./xstate.actorcontext.logger.md) | | (...args: any\[\]) => void | | +| [self](./xstate.actorcontext.self.md) | | [ActorRef](./xstate.actorref.md)<><TEvent, TSnapshot> | | +| [sessionId](./xstate.actorcontext.sessionid.md) | | string | | +| [stopChild](./xstate.actorcontext.stopchild.md) | | (child: [AnyActorRef](./xstate.anyactorref.md)<>) => void | | +| [system](./xstate.actorcontext.system.md) | | TSystem | | + diff --git a/api/xstate/xstate.actorcontext.self.md b/api/xstate/xstate.actorcontext.self.md new file mode 100644 index 000000000..333487b3c --- /dev/null +++ b/api/xstate/xstate.actorcontext.self.md @@ -0,0 +1,18 @@ +--- +title: "self" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorContext.self property + +**Signature:** + +```typescript +self: ActorRef; +``` diff --git a/api/xstate/xstate.actorcontext.sessionid.md b/api/xstate/xstate.actorcontext.sessionid.md new file mode 100644 index 000000000..375f05f86 --- /dev/null +++ b/api/xstate/xstate.actorcontext.sessionid.md @@ -0,0 +1,18 @@ +--- +title: "sessionId" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorContext.sessionId property + +**Signature:** + +```typescript +sessionId: string; +``` diff --git a/api/xstate/xstate.actorcontext.stopchild.md b/api/xstate/xstate.actorcontext.stopchild.md new file mode 100644 index 000000000..5a89aab26 --- /dev/null +++ b/api/xstate/xstate.actorcontext.stopchild.md @@ -0,0 +1,18 @@ +--- +title: "stopChild" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorContext.stopChild property + +**Signature:** + +```typescript +stopChild: (child: AnyActorRef) => void; +``` diff --git a/api/xstate/xstate.actorcontext.system.md b/api/xstate/xstate.actorcontext.system.md new file mode 100644 index 000000000..8f69a23cf --- /dev/null +++ b/api/xstate/xstate.actorcontext.system.md @@ -0,0 +1,18 @@ +--- +title: "system" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorContext.system property + +**Signature:** + +```typescript +system: TSystem; +``` diff --git a/api/xstate/xstate.actorlike.md b/api/xstate/xstate.actorlike.md new file mode 100644 index 000000000..d70a9875d --- /dev/null +++ b/api/xstate/xstate.actorlike.md @@ -0,0 +1,26 @@ +--- +title: "ActorLike" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLike interface + +**Signature:** + +```typescript +export interface ActorLike extends Subscribable +``` +**Extends:** [Subscribable](./xstate.subscribable.md)<><TCurrent> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [send](./xstate.actorlike.send.md) | | (event: TEvent) => void | | + diff --git a/api/xstate/xstate.actorlike.send.md b/api/xstate/xstate.actorlike.send.md new file mode 100644 index 000000000..29573c58b --- /dev/null +++ b/api/xstate/xstate.actorlike.send.md @@ -0,0 +1,18 @@ +--- +title: "send" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLike.send property + +**Signature:** + +```typescript +send: (event: TEvent) => void; +``` diff --git a/api/xstate/xstate.actorlogic.config.md b/api/xstate/xstate.actorlogic.config.md new file mode 100644 index 000000000..bff12c1c2 --- /dev/null +++ b/api/xstate/xstate.actorlogic.config.md @@ -0,0 +1,18 @@ +--- +title: "config" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLogic.config property + +**Signature:** + +```typescript +config?: unknown; +``` diff --git a/api/xstate/xstate.actorlogic.getinitialstate.md b/api/xstate/xstate.actorlogic.getinitialstate.md new file mode 100644 index 000000000..5c6d22340 --- /dev/null +++ b/api/xstate/xstate.actorlogic.getinitialstate.md @@ -0,0 +1,18 @@ +--- +title: "getInitialState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLogic.getInitialState property + +**Signature:** + +```typescript +getInitialState: (actorCtx: ActorContext, input: TInput) => TSnapshot; +``` diff --git a/api/xstate/xstate.actorlogic.getpersistedstate.md b/api/xstate/xstate.actorlogic.getpersistedstate.md new file mode 100644 index 000000000..30d26f0ab --- /dev/null +++ b/api/xstate/xstate.actorlogic.getpersistedstate.md @@ -0,0 +1,18 @@ +--- +title: "getPersistedState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLogic.getPersistedState property + +**Signature:** + +```typescript +getPersistedState?: (state: TSnapshot) => TPersisted; +``` diff --git a/api/xstate/xstate.actorlogic.md b/api/xstate/xstate.actorlogic.md new file mode 100644 index 000000000..861e75502 --- /dev/null +++ b/api/xstate/xstate.actorlogic.md @@ -0,0 +1,34 @@ +--- +title: "ActorLogic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLogic interface + +**Signature:** + +```typescript +export interface ActorLogic, TEvent extends EventObject, TInput = unknown, +/** + * Serialized internal state used for persistence & restoration + */ +TPersisted = TSnapshot, TSystem extends ActorSystem = ActorSystem> +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [config?](./xstate.actorlogic.config.md) | | unknown | _(Optional)_ | +| [getInitialState](./xstate.actorlogic.getinitialstate.md) | | (actorCtx: [ActorContext](./xstate.actorcontext.md)<><TSnapshot, TEvent, TSystem>, input: TInput) => TSnapshot | | +| [getPersistedState?](./xstate.actorlogic.getpersistedstate.md) | | (state: TSnapshot) => TPersisted | _(Optional)_ | +| [restoreState?](./xstate.actorlogic.restorestate.md) | | (persistedState: TPersisted, actorCtx: [ActorContext](./xstate.actorcontext.md)<><TSnapshot, TEvent>) => TSnapshot | _(Optional)_ | +| [start?](./xstate.actorlogic.start.md) | | (state: TSnapshot, actorCtx: [ActorContext](./xstate.actorcontext.md)<><TSnapshot, TEvent>) => void | _(Optional)_ | +| [transition](./xstate.actorlogic.transition.md) | | (state: TSnapshot, message: TEvent, ctx: [ActorContext](./xstate.actorcontext.md)<><TSnapshot, TEvent, TSystem>) => TSnapshot | | + diff --git a/api/xstate/xstate.actorlogic.restorestate.md b/api/xstate/xstate.actorlogic.restorestate.md new file mode 100644 index 000000000..ad557fab7 --- /dev/null +++ b/api/xstate/xstate.actorlogic.restorestate.md @@ -0,0 +1,18 @@ +--- +title: "restoreState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLogic.restoreState property + +**Signature:** + +```typescript +restoreState?: (persistedState: TPersisted, actorCtx: ActorContext) => TSnapshot; +``` diff --git a/api/xstate/xstate.actorlogic.start.md b/api/xstate/xstate.actorlogic.start.md new file mode 100644 index 000000000..ade88685f --- /dev/null +++ b/api/xstate/xstate.actorlogic.start.md @@ -0,0 +1,18 @@ +--- +title: "start" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLogic.start property + +**Signature:** + +```typescript +start?: (state: TSnapshot, actorCtx: ActorContext) => void; +``` diff --git a/api/xstate/xstate.actorlogic.transition.md b/api/xstate/xstate.actorlogic.transition.md new file mode 100644 index 000000000..5a83560db --- /dev/null +++ b/api/xstate/xstate.actorlogic.transition.md @@ -0,0 +1,18 @@ +--- +title: "transition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLogic.transition property + +**Signature:** + +```typescript +transition: (state: TSnapshot, message: TEvent, ctx: ActorContext) => TSnapshot; +``` diff --git a/api/xstate/xstate.actorlogicfrom.md b/api/xstate/xstate.actorlogicfrom.md new file mode 100644 index 000000000..fd6bc5776 --- /dev/null +++ b/api/xstate/xstate.actorlogicfrom.md @@ -0,0 +1,20 @@ +--- +title: "ActorLogicFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorLogicFrom type + +**Signature:** + +```typescript +export type ActorLogicFrom = ReturnTypeOrValue extends infer R ? R extends StateMachine ? R : R extends Promise ? PromiseActorLogic : never : never; +``` +**References:** [StateMachine](./xstate.statemachine.md)<>, [PromiseActorLogic](./xstate.promiseactorlogic.md) + diff --git a/api/xstate/xstate.actoroptions.clock.md b/api/xstate/xstate.actoroptions.clock.md new file mode 100644 index 000000000..303f19bdc --- /dev/null +++ b/api/xstate/xstate.actoroptions.clock.md @@ -0,0 +1,18 @@ +--- +title: "clock" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.clock property + +**Signature:** + +```typescript +clock?: Clock; +``` diff --git a/api/xstate/xstate.actoroptions.devtools.md b/api/xstate/xstate.actoroptions.devtools.md new file mode 100644 index 000000000..35fffd94e --- /dev/null +++ b/api/xstate/xstate.actoroptions.devtools.md @@ -0,0 +1,22 @@ +--- +title: "devTools" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.devTools property + +If `true`<>, states and events will be logged to Redux DevTools. + +Default: `false` + +**Signature:** + +```typescript +devTools?: boolean | DevToolsAdapter; +``` diff --git a/api/xstate/xstate.actoroptions.execute.md b/api/xstate/xstate.actoroptions.execute.md new file mode 100644 index 000000000..c7801c811 --- /dev/null +++ b/api/xstate/xstate.actoroptions.execute.md @@ -0,0 +1,20 @@ +--- +title: "execute" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.execute property + +Whether state actions should be executed immediately upon transition. Defaults to `true`<>. + +**Signature:** + +```typescript +execute?: boolean; +``` diff --git a/api/xstate/xstate.actoroptions.id.md b/api/xstate/xstate.actoroptions.id.md new file mode 100644 index 000000000..2517f1288 --- /dev/null +++ b/api/xstate/xstate.actoroptions.id.md @@ -0,0 +1,20 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.id property + +The custom `id` for referencing this service. + +**Signature:** + +```typescript +id?: string; +``` diff --git a/api/xstate/xstate.actoroptions.input.md b/api/xstate/xstate.actoroptions.input.md new file mode 100644 index 000000000..7a882467c --- /dev/null +++ b/api/xstate/xstate.actoroptions.input.md @@ -0,0 +1,20 @@ +--- +title: "input" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.input property + +The input data to pass to the actor. + +**Signature:** + +```typescript +input?: InputFrom; +``` diff --git a/api/xstate/xstate.actoroptions.inspect.md b/api/xstate/xstate.actoroptions.inspect.md new file mode 100644 index 000000000..1fa5f0744 --- /dev/null +++ b/api/xstate/xstate.actoroptions.inspect.md @@ -0,0 +1,18 @@ +--- +title: "inspect" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.inspect property + +**Signature:** + +```typescript +inspect?: Observer | ((inspectionEvent: InspectionEvent) => void); +``` diff --git a/api/xstate/xstate.actoroptions.logger.md b/api/xstate/xstate.actoroptions.logger.md new file mode 100644 index 000000000..63528cf1e --- /dev/null +++ b/api/xstate/xstate.actoroptions.logger.md @@ -0,0 +1,18 @@ +--- +title: "logger" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.logger property + +**Signature:** + +```typescript +logger?: (...args: any[]) => void; +``` diff --git a/api/xstate/xstate.actoroptions.md b/api/xstate/xstate.actoroptions.md new file mode 100644 index 000000000..babd68c80 --- /dev/null +++ b/api/xstate/xstate.actoroptions.md @@ -0,0 +1,36 @@ +--- +title: "ActorOptions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions interface + +**Signature:** + +```typescript +export interface ActorOptions +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [clock?](./xstate.actoroptions.clock.md) | | Clock | _(Optional)_ | +| [devTools?](./xstate.actoroptions.devtools.md) | | boolean \| [DevToolsAdapter](./xstate.devtoolsadapter.md) |

_(Optional)_ If true, states and events will be logged to Redux DevTools.

Default: false

| +| [execute?](./xstate.actoroptions.execute.md) | | boolean | _(Optional)_ Whether state actions should be executed immediately upon transition. Defaults to true. | +| [id?](./xstate.actoroptions.id.md) | | string | _(Optional)_ The custom id for referencing this service. | +| [input?](./xstate.actoroptions.input.md) | | [InputFrom](./xstate.inputfrom.md)<><TLogic> | _(Optional)_ The input data to pass to the actor. | +| [inspect?](./xstate.actoroptions.inspect.md) | | [Observer](./xstate.observer.md)<><[InspectionEvent](./xstate.inspectionevent.md)<>> \| ((inspectionEvent: [InspectionEvent](./xstate.inspectionevent.md)<>) => void) | _(Optional)_ | +| [logger?](./xstate.actoroptions.logger.md) | | (...args: any\[\]) => void | _(Optional)_ | +| [parent?](./xstate.actoroptions.parent.md) | | [ActorRef](./xstate.actorref.md)<><any, any> | _(Optional)_ | +| [src?](./xstate.actoroptions.src.md) | | string | _(Optional)_ The source definition. | +| [state?](./xstate.actoroptions.state.md) | | any | _(Optional)_ | +| [sync?](./xstate.actoroptions.sync.md) | | boolean | _(Optional)_ | +| [systemId?](./xstate.actoroptions.systemid.md) | | string | _(Optional)_ The system ID to register this actor under | + diff --git a/api/xstate/xstate.actoroptions.parent.md b/api/xstate/xstate.actoroptions.parent.md new file mode 100644 index 000000000..a698b14ab --- /dev/null +++ b/api/xstate/xstate.actoroptions.parent.md @@ -0,0 +1,18 @@ +--- +title: "parent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.parent property + +**Signature:** + +```typescript +parent?: ActorRef; +``` diff --git a/api/xstate/xstate.actoroptions.src.md b/api/xstate/xstate.actoroptions.src.md new file mode 100644 index 000000000..7ae7b7e47 --- /dev/null +++ b/api/xstate/xstate.actoroptions.src.md @@ -0,0 +1,20 @@ +--- +title: "src" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.src property + +The source definition. + +**Signature:** + +```typescript +src?: string; +``` diff --git a/api/xstate/xstate.actoroptions.state.md b/api/xstate/xstate.actoroptions.state.md new file mode 100644 index 000000000..19195cb8f --- /dev/null +++ b/api/xstate/xstate.actoroptions.state.md @@ -0,0 +1,18 @@ +--- +title: "state" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.state property + +**Signature:** + +```typescript +state?: any; +``` diff --git a/api/xstate/xstate.actoroptions.sync.md b/api/xstate/xstate.actoroptions.sync.md new file mode 100644 index 000000000..fde2bc2e8 --- /dev/null +++ b/api/xstate/xstate.actoroptions.sync.md @@ -0,0 +1,18 @@ +--- +title: "sync" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.sync property + +**Signature:** + +```typescript +sync?: boolean; +``` diff --git a/api/xstate/xstate.actoroptions.systemid.md b/api/xstate/xstate.actoroptions.systemid.md new file mode 100644 index 000000000..95336c7f0 --- /dev/null +++ b/api/xstate/xstate.actoroptions.systemid.md @@ -0,0 +1,20 @@ +--- +title: "systemId" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorOptions.systemId property + +The system ID to register this actor under + +**Signature:** + +```typescript +systemId?: string; +``` diff --git a/api/xstate/xstate.actorref._parent.md b/api/xstate/xstate.actorref._parent.md new file mode 100644 index 000000000..93cb3de3c --- /dev/null +++ b/api/xstate/xstate.actorref._parent.md @@ -0,0 +1,18 @@ +--- +title: "_parent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.\_parent property + +**Signature:** + +```typescript +_parent?: ActorRef; +``` diff --git a/api/xstate/xstate.actorref.getpersistedstate.md b/api/xstate/xstate.actorref.getpersistedstate.md new file mode 100644 index 000000000..8bdd0d03e --- /dev/null +++ b/api/xstate/xstate.actorref.getpersistedstate.md @@ -0,0 +1,18 @@ +--- +title: "getPersistedState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.getPersistedState property + +**Signature:** + +```typescript +getPersistedState?: () => any; +``` diff --git a/api/xstate/xstate.actorref.getsnapshot.md b/api/xstate/xstate.actorref.getsnapshot.md new file mode 100644 index 000000000..d5d4efb01 --- /dev/null +++ b/api/xstate/xstate.actorref.getsnapshot.md @@ -0,0 +1,18 @@ +--- +title: "getSnapshot" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.getSnapshot property + +**Signature:** + +```typescript +getSnapshot: () => TSnapshot; +``` diff --git a/api/xstate/xstate.actorref.id.md b/api/xstate/xstate.actorref.id.md new file mode 100644 index 000000000..29fb0aabe --- /dev/null +++ b/api/xstate/xstate.actorref.id.md @@ -0,0 +1,20 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.id property + +The unique identifier for this actor relative to its parent. + +**Signature:** + +```typescript +id: string; +``` diff --git a/api/xstate/xstate.actorref.md b/api/xstate/xstate.actorref.md new file mode 100644 index 000000000..96f62dea4 --- /dev/null +++ b/api/xstate/xstate.actorref.md @@ -0,0 +1,37 @@ +--- +title: "ActorRef" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef interface + +**Signature:** + +```typescript +export interface ActorRef> extends Subscribable, InteropObservable +``` +**Extends:** [Subscribable](./xstate.subscribable.md)<><TSnapshot>, [InteropObservable](./xstate.interopobservable.md)<><TSnapshot> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_parent?](./xstate.actorref._parent.md) | | [ActorRef](./xstate.actorref.md)<><any, any> | _(Optional)_ | +| [getPersistedState?](./xstate.actorref.getpersistedstate.md) | | () => any | _(Optional)_ | +| [getSnapshot](./xstate.actorref.getsnapshot.md) | | () => TSnapshot | | +| [id](./xstate.actorref.id.md) | | string | The unique identifier for this actor relative to its parent. | +| [send](./xstate.actorref.send.md) | | (event: TEvent) => void | | +| [sessionId](./xstate.actorref.sessionid.md) | | string | | +| [src?](./xstate.actorref.src.md) | | string | _(Optional)_ | +| [start?](./xstate.actorref.start.md) | | () => void | _(Optional)_ | +| [status](./xstate.actorref.status.md) | | [ActorStatus](./xstate.actorstatus.md) | | +| [stop](./xstate.actorref.stop.md) | | () => void | | +| [system?](./xstate.actorref.system.md) | | [ActorSystem](./xstate.actorsystem.md)<><any> | _(Optional)_ | +| [toJSON?](./xstate.actorref.tojson.md) | | () => any | _(Optional)_ | + diff --git a/api/xstate/xstate.actorref.send.md b/api/xstate/xstate.actorref.send.md new file mode 100644 index 000000000..8e9875e7b --- /dev/null +++ b/api/xstate/xstate.actorref.send.md @@ -0,0 +1,18 @@ +--- +title: "send" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.send property + +**Signature:** + +```typescript +send: (event: TEvent) => void; +``` diff --git a/api/xstate/xstate.actorref.sessionid.md b/api/xstate/xstate.actorref.sessionid.md new file mode 100644 index 000000000..ddb8b91e2 --- /dev/null +++ b/api/xstate/xstate.actorref.sessionid.md @@ -0,0 +1,18 @@ +--- +title: "sessionId" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.sessionId property + +**Signature:** + +```typescript +sessionId: string; +``` diff --git a/api/xstate/xstate.actorref.src.md b/api/xstate/xstate.actorref.src.md new file mode 100644 index 000000000..789ce7094 --- /dev/null +++ b/api/xstate/xstate.actorref.src.md @@ -0,0 +1,18 @@ +--- +title: "src" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.src property + +**Signature:** + +```typescript +src?: string; +``` diff --git a/api/xstate/xstate.actorref.start.md b/api/xstate/xstate.actorref.start.md new file mode 100644 index 000000000..f58204b2d --- /dev/null +++ b/api/xstate/xstate.actorref.start.md @@ -0,0 +1,18 @@ +--- +title: "start" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.start property + +**Signature:** + +```typescript +start?: () => void; +``` diff --git a/api/xstate/xstate.actorref.status.md b/api/xstate/xstate.actorref.status.md new file mode 100644 index 000000000..f5e8aec3c --- /dev/null +++ b/api/xstate/xstate.actorref.status.md @@ -0,0 +1,18 @@ +--- +title: "status" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.status property + +**Signature:** + +```typescript +status: ActorStatus; +``` diff --git a/api/xstate/xstate.actorref.stop.md b/api/xstate/xstate.actorref.stop.md new file mode 100644 index 000000000..568f43680 --- /dev/null +++ b/api/xstate/xstate.actorref.stop.md @@ -0,0 +1,18 @@ +--- +title: "stop" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.stop property + +**Signature:** + +```typescript +stop: () => void; +``` diff --git a/api/xstate/xstate.actorref.system.md b/api/xstate/xstate.actorref.system.md new file mode 100644 index 000000000..71cd051b0 --- /dev/null +++ b/api/xstate/xstate.actorref.system.md @@ -0,0 +1,18 @@ +--- +title: "system" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.system property + +**Signature:** + +```typescript +system?: ActorSystem; +``` diff --git a/api/xstate/xstate.actorref.tojson.md b/api/xstate/xstate.actorref.tojson.md new file mode 100644 index 000000000..2680e402d --- /dev/null +++ b/api/xstate/xstate.actorref.tojson.md @@ -0,0 +1,18 @@ +--- +title: "toJSON" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRef.toJSON property + +**Signature:** + +```typescript +toJSON?: () => any; +``` diff --git a/api/xstate/xstate.actorreffrom.md b/api/xstate/xstate.actorreffrom.md new file mode 100644 index 000000000..f9d7a0ad3 --- /dev/null +++ b/api/xstate/xstate.actorreffrom.md @@ -0,0 +1,20 @@ +--- +title: "ActorRefFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorRefFrom type + +**Signature:** + +```typescript +export type ActorRefFrom = ReturnTypeOrValue extends infer R ? R extends StateMachine ? ActorRef extends false ? MarkAllImplementationsAsProvided : TResolvedTypesMeta>> : R extends Promise ? ActorRefFrom> : R extends ActorLogic ? ActorRef : never : never; +``` +**References:** [StateMachine](./xstate.statemachine.md)<>, [ActorRef](./xstate.actorref.md)<>, [MachineSnapshot](./xstate.machinesnapshot.md)<>, [AreAllImplementationsAssumedToBeProvided](./xstate.areallimplementationsassumedtobeprovided.md)<>, [MarkAllImplementationsAsProvided](./xstate.markallimplementationsasprovided.md)<>, [ActorRefFrom](./xstate.actorreffrom.md)<>, [PromiseActorLogic](./xstate.promiseactorlogic.md)<>, [ActorLogic](./xstate.actorlogic.md) + diff --git a/api/xstate/xstate.actorstatus.md b/api/xstate/xstate.actorstatus.md new file mode 100644 index 000000000..c3a3920cf --- /dev/null +++ b/api/xstate/xstate.actorstatus.md @@ -0,0 +1,27 @@ +--- +title: "ActorStatus" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorStatus enum + +**Signature:** + +```typescript +export declare enum ActorStatus +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| NotStarted | 0 | | +| Running | 1 | | +| Stopped | 2 | | + diff --git a/api/xstate/xstate.actorsystem.get.md b/api/xstate/xstate.actorsystem.get.md new file mode 100644 index 000000000..6e0137bc4 --- /dev/null +++ b/api/xstate/xstate.actorsystem.get.md @@ -0,0 +1,18 @@ +--- +title: "get" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorSystem.get property + +**Signature:** + +```typescript +get: (key: K) => T['actors'][K] | undefined; +``` diff --git a/api/xstate/xstate.actorsystem.inspect.md b/api/xstate/xstate.actorsystem.inspect.md new file mode 100644 index 000000000..12c8173f4 --- /dev/null +++ b/api/xstate/xstate.actorsystem.inspect.md @@ -0,0 +1,18 @@ +--- +title: "inspect" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorSystem.inspect property + +**Signature:** + +```typescript +inspect: (observer: Observer) => void; +``` diff --git a/api/xstate/xstate.actorsystem.md b/api/xstate/xstate.actorsystem.md new file mode 100644 index 000000000..11f5c5bfc --- /dev/null +++ b/api/xstate/xstate.actorsystem.md @@ -0,0 +1,26 @@ +--- +title: "ActorSystem" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorSystem interface + +**Signature:** + +```typescript +export interface ActorSystem +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [get](./xstate.actorsystem.get.md) | | <K extends keyof T\['actors'\]>(key: K) => T\['actors'\]\[K\] \| undefined | | +| [inspect](./xstate.actorsystem.inspect.md) | | (observer: [Observer](./xstate.observer.md)<><[InspectionEvent](./xstate.inspectionevent.md)<>>) => void | | + diff --git a/api/xstate/xstate.actorsysteminfo.actors.md b/api/xstate/xstate.actorsysteminfo.actors.md new file mode 100644 index 000000000..46632c5cd --- /dev/null +++ b/api/xstate/xstate.actorsysteminfo.actors.md @@ -0,0 +1,18 @@ +--- +title: "actors" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorSystemInfo.actors property + +**Signature:** + +```typescript +actors: Record; +``` diff --git a/api/xstate/xstate.actorsysteminfo.md b/api/xstate/xstate.actorsysteminfo.md new file mode 100644 index 000000000..aa7e95ccf --- /dev/null +++ b/api/xstate/xstate.actorsysteminfo.md @@ -0,0 +1,25 @@ +--- +title: "ActorSystemInfo" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ActorSystemInfo interface + +**Signature:** + +```typescript +export interface ActorSystemInfo +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actors](./xstate.actorsysteminfo.actors.md) | | Record<string, [AnyActorRef](./xstate.anyactorref.md)<>> | | + diff --git a/api/xstate/xstate.and.md b/api/xstate/xstate.and.md new file mode 100644 index 000000000..5cce0e4ca --- /dev/null +++ b/api/xstate/xstate.and.md @@ -0,0 +1,29 @@ +--- +title: "and" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## and() function + +**Signature:** + +```typescript +export declare function and(guards: ReadonlyArray>>): GuardPredicate; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| guards | ReadonlyArray<Guard<TContext, TExpressionEvent, TExpressionGuard, [NoInfer](./xstate.noinfer.md)<><TGuard>>> | | + +**Returns:** + +GuardPredicate<TContext, TExpressionEvent, TExpressionGuard, TGuard> + diff --git a/api/xstate/xstate.anyactor.md b/api/xstate/xstate.anyactor.md new file mode 100644 index 000000000..9f09bb7e2 --- /dev/null +++ b/api/xstate/xstate.anyactor.md @@ -0,0 +1,20 @@ +--- +title: "AnyActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyActor type + +**Signature:** + +```typescript +export type AnyActor = Actor; +``` +**References:** [Actor](./xstate.actor.md) + diff --git a/api/xstate/xstate.anyactorcontext.md b/api/xstate/xstate.anyactorcontext.md new file mode 100644 index 000000000..812ce5b32 --- /dev/null +++ b/api/xstate/xstate.anyactorcontext.md @@ -0,0 +1,20 @@ +--- +title: "AnyActorContext" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyActorContext type + +**Signature:** + +```typescript +export type AnyActorContext = ActorContext; +``` +**References:** [ActorContext](./xstate.actorcontext.md)<>, [AnyActorSystem](./xstate.anyactorsystem.md) + diff --git a/api/xstate/xstate.anyactorlogic.md b/api/xstate/xstate.anyactorlogic.md new file mode 100644 index 000000000..1771bdb66 --- /dev/null +++ b/api/xstate/xstate.anyactorlogic.md @@ -0,0 +1,24 @@ +--- +title: "AnyActorLogic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyActorLogic type + +**Signature:** + +```typescript +export type AnyActorLogic = ActorLogic; +``` +**References:** [ActorLogic](./xstate.actorlogic.md) + diff --git a/api/xstate/xstate.anyactorref.md b/api/xstate/xstate.anyactorref.md new file mode 100644 index 000000000..9395e0560 --- /dev/null +++ b/api/xstate/xstate.anyactorref.md @@ -0,0 +1,20 @@ +--- +title: "AnyActorRef" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyActorRef type + +**Signature:** + +```typescript +export type AnyActorRef = ActorRef; +``` +**References:** [ActorRef](./xstate.actorref.md) + diff --git a/api/xstate/xstate.anyactorsystem.md b/api/xstate/xstate.anyactorsystem.md new file mode 100644 index 000000000..3d2e237de --- /dev/null +++ b/api/xstate/xstate.anyactorsystem.md @@ -0,0 +1,20 @@ +--- +title: "AnyActorSystem" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyActorSystem type + +**Signature:** + +```typescript +export type AnyActorSystem = ActorSystem; +``` +**References:** [ActorSystem](./xstate.actorsystem.md) + diff --git a/api/xstate/xstate.anyeventobject.md b/api/xstate/xstate.anyeventobject.md new file mode 100644 index 000000000..7ded5d2ce --- /dev/null +++ b/api/xstate/xstate.anyeventobject.md @@ -0,0 +1,20 @@ +--- +title: "AnyEventObject" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyEventObject interface + +**Signature:** + +```typescript +export interface AnyEventObject extends EventObject +``` +**Extends:** [EventObject](./xstate.eventobject.md) + diff --git a/api/xstate/xstate.anyfunction.md b/api/xstate/xstate.anyfunction.md new file mode 100644 index 000000000..2f9866fd8 --- /dev/null +++ b/api/xstate/xstate.anyfunction.md @@ -0,0 +1,18 @@ +--- +title: "AnyFunction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyFunction type + +**Signature:** + +```typescript +export type AnyFunction = (...args: any[]) => any; +``` diff --git a/api/xstate/xstate.anyhistoryvalue.md b/api/xstate/xstate.anyhistoryvalue.md new file mode 100644 index 000000000..04b810d6b --- /dev/null +++ b/api/xstate/xstate.anyhistoryvalue.md @@ -0,0 +1,20 @@ +--- +title: "AnyHistoryValue" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyHistoryValue type + +**Signature:** + +```typescript +export type AnyHistoryValue = HistoryValue; +``` +**References:** [HistoryValue](./xstate.historyvalue.md) + diff --git a/api/xstate/xstate.anyinterpreter.md b/api/xstate/xstate.anyinterpreter.md new file mode 100644 index 000000000..f1a5483ce --- /dev/null +++ b/api/xstate/xstate.anyinterpreter.md @@ -0,0 +1,25 @@ +--- +title: "AnyInterpreter" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyInterpreter type + +> Warning: This API is now obsolete. +> +> Use `AnyActor` instead. +> + +**Signature:** + +```typescript +export type AnyInterpreter = AnyActor; +``` +**References:** [AnyActor](./xstate.anyactor.md) + diff --git a/api/xstate/xstate.anyinvokeconfig.md b/api/xstate/xstate.anyinvokeconfig.md new file mode 100644 index 000000000..f88196b49 --- /dev/null +++ b/api/xstate/xstate.anyinvokeconfig.md @@ -0,0 +1,20 @@ +--- +title: "AnyInvokeConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyInvokeConfig type + +**Signature:** + +```typescript +export type AnyInvokeConfig = InvokeConfig; +``` +**References:** [InvokeConfig](./xstate.invokeconfig.md) + diff --git a/api/xstate/xstate.anystate.md b/api/xstate/xstate.anystate.md new file mode 100644 index 000000000..c80a3e9d1 --- /dev/null +++ b/api/xstate/xstate.anystate.md @@ -0,0 +1,24 @@ +--- +title: "AnyState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyState type + +**Signature:** + +```typescript +export type AnyState = State; +``` +**References:** [State](./xstate.state.md) + diff --git a/api/xstate/xstate.anystateconfig.md b/api/xstate/xstate.anystateconfig.md new file mode 100644 index 000000000..ef1f8efc7 --- /dev/null +++ b/api/xstate/xstate.anystateconfig.md @@ -0,0 +1,20 @@ +--- +title: "AnyStateConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyStateConfig type + +**Signature:** + +```typescript +export type AnyStateConfig = StateConfig; +``` +**References:** [StateConfig](./xstate.stateconfig.md)<>, [AnyEventObject](./xstate.anyeventobject.md) + diff --git a/api/xstate/xstate.anystatemachine.md b/api/xstate/xstate.anystatemachine.md new file mode 100644 index 000000000..5b225e7cf --- /dev/null +++ b/api/xstate/xstate.anystatemachine.md @@ -0,0 +1,21 @@ +--- +title: "AnyStateMachine" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyStateMachine type + +**Signature:** + +```typescript +export type AnyStateMachine = StateMachine; +``` +**References:** [StateMachine](./xstate.statemachine.md) + diff --git a/api/xstate/xstate.anystatenode.md b/api/xstate/xstate.anystatenode.md new file mode 100644 index 000000000..b68e1f192 --- /dev/null +++ b/api/xstate/xstate.anystatenode.md @@ -0,0 +1,20 @@ +--- +title: "AnyStateNode" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyStateNode type + +**Signature:** + +```typescript +export type AnyStateNode = StateNode; +``` +**References:** [StateNode](./xstate.statenode.md) + diff --git a/api/xstate/xstate.anystatenodeconfig.md b/api/xstate/xstate.anystatenodeconfig.md new file mode 100644 index 000000000..41da15e2d --- /dev/null +++ b/api/xstate/xstate.anystatenodeconfig.md @@ -0,0 +1,20 @@ +--- +title: "AnyStateNodeConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyStateNodeConfig type + +**Signature:** + +```typescript +export type AnyStateNodeConfig = StateNodeConfig; +``` +**References:** [StateNodeConfig](./xstate.statenodeconfig.md) + diff --git a/api/xstate/xstate.anystatenodedefinition.md b/api/xstate/xstate.anystatenodedefinition.md new file mode 100644 index 000000000..332059e5e --- /dev/null +++ b/api/xstate/xstate.anystatenodedefinition.md @@ -0,0 +1,20 @@ +--- +title: "AnyStateNodeDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyStateNodeDefinition type + +**Signature:** + +```typescript +export type AnyStateNodeDefinition = StateNodeDefinition; +``` +**References:** [StateNodeDefinition](./xstate.statenodedefinition.md) + diff --git a/api/xstate/xstate.anytransitionconfig.md b/api/xstate/xstate.anytransitionconfig.md new file mode 100644 index 000000000..accd53ea7 --- /dev/null +++ b/api/xstate/xstate.anytransitionconfig.md @@ -0,0 +1,20 @@ +--- +title: "AnyTransitionConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyTransitionConfig type + +**Signature:** + +```typescript +export type AnyTransitionConfig = TransitionConfig; +``` +**References:** [TransitionConfig](./xstate.transitionconfig.md) + diff --git a/api/xstate/xstate.anytransitiondefinition.md b/api/xstate/xstate.anytransitiondefinition.md new file mode 100644 index 000000000..bbc5bcc42 --- /dev/null +++ b/api/xstate/xstate.anytransitiondefinition.md @@ -0,0 +1,20 @@ +--- +title: "AnyTransitionDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AnyTransitionDefinition type + +**Signature:** + +```typescript +export type AnyTransitionDefinition = TransitionDefinition; +``` +**References:** [TransitionDefinition](./xstate.transitiondefinition.md) + diff --git a/api/xstate/xstate.areallimplementationsassumedtobeprovided.md b/api/xstate/xstate.areallimplementationsassumedtobeprovided.md new file mode 100644 index 000000000..3a499c9a7 --- /dev/null +++ b/api/xstate/xstate.areallimplementationsassumedtobeprovided.md @@ -0,0 +1,22 @@ +--- +title: "AreAllImplementationsAssumedToBeProvided" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AreAllImplementationsAssumedToBeProvided type + +**Signature:** + +```typescript +export type AreAllImplementationsAssumedToBeProvided, 'missingImplementations'>> = IsAny extends true ? true : TResolvedTypesMeta extends TypegenEnabled ? IsNever> extends true ? true : false : true; +``` +**References:** [Prop](./xstate.prop.md)<>, [IsAny](./xstate.isany.md)<>, [TypegenEnabled](./xstate.typegenenabled.md)<>, [IsNever](./xstate.isnever.md)<>, [Values](./xstate.values.md) + diff --git a/api/xstate/xstate.assign.md b/api/xstate/xstate.assign.md new file mode 100644 index 000000000..8b606c365 --- /dev/null +++ b/api/xstate/xstate.assign.md @@ -0,0 +1,32 @@ +--- +title: "assign" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## assign() function + +Updates the current context of the machine. + +**Signature:** + +```typescript +export declare function assign(assignment: Assigner, TExpressionEvent, TExpressionAction, TEvent, TActor> | PropertyAssigner, TExpressionEvent, TExpressionAction, TEvent, TActor>): AssignAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| assignment | [Assigner](./xstate.assigner.md)<><[LowInfer](./xstate.lowinfer.md)<><TContext>, TExpressionEvent, TExpressionAction, TEvent, TActor> \| [PropertyAssigner](./xstate.propertyassigner.md)<><[LowInfer](./xstate.lowinfer.md)<><TContext>, TExpressionEvent, TExpressionAction, TEvent, TActor> | An object that represents the partial context to update. | + +**Returns:** + +[AssignAction](./xstate.assignaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TActor> + diff --git a/api/xstate/xstate.assignaction._out_tactor.md b/api/xstate/xstate.assignaction._out_tactor.md new file mode 100644 index 000000000..ee8b94ba5 --- /dev/null +++ b/api/xstate/xstate.assignaction._out_tactor.md @@ -0,0 +1,18 @@ +--- +title: "_out_TActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AssignAction.\_out\_TActor property + +**Signature:** + +```typescript +_out_TActor?: TActor; +``` diff --git a/api/xstate/xstate.assignaction.md b/api/xstate/xstate.assignaction.md new file mode 100644 index 000000000..25f1fcea0 --- /dev/null +++ b/api/xstate/xstate.assignaction.md @@ -0,0 +1,25 @@ +--- +title: "AssignAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AssignAction interface + +**Signature:** + +```typescript +export interface AssignAction +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_out\_TActor?](./xstate.assignaction._out_tactor.md) | | TActor | _(Optional)_ | + diff --git a/api/xstate/xstate.assignargs.md b/api/xstate/xstate.assignargs.md new file mode 100644 index 000000000..b51961b87 --- /dev/null +++ b/api/xstate/xstate.assignargs.md @@ -0,0 +1,26 @@ +--- +title: "AssignArgs" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AssignArgs interface + +**Signature:** + +```typescript +export interface AssignArgs extends ActionArgs +``` +**Extends:** [ActionArgs](./xstate.actionargs.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [spawn](./xstate.assignargs.spawn.md) | | [Spawner](./xstate.spawner.md)<><TActor> | | + diff --git a/api/xstate/xstate.assignargs.spawn.md b/api/xstate/xstate.assignargs.spawn.md new file mode 100644 index 000000000..4986d8b66 --- /dev/null +++ b/api/xstate/xstate.assignargs.spawn.md @@ -0,0 +1,18 @@ +--- +title: "spawn" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AssignArgs.spawn property + +**Signature:** + +```typescript +spawn: Spawner; +``` diff --git a/api/xstate/xstate.assigner.md b/api/xstate/xstate.assigner.md new file mode 100644 index 000000000..2d7a8cecd --- /dev/null +++ b/api/xstate/xstate.assigner.md @@ -0,0 +1,20 @@ +--- +title: "Assigner" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Assigner type + +**Signature:** + +```typescript +export type Assigner = (args: AssignArgs) => Partial; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [AssignArgs](./xstate.assignargs.md) + diff --git a/api/xstate/xstate.atomicstatenodeconfig.initial.md b/api/xstate/xstate.atomicstatenodeconfig.initial.md new file mode 100644 index 000000000..2cc22988c --- /dev/null +++ b/api/xstate/xstate.atomicstatenodeconfig.initial.md @@ -0,0 +1,18 @@ +--- +title: "initial" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AtomicStateNodeConfig.initial property + +**Signature:** + +```typescript +initial?: undefined; +``` diff --git a/api/xstate/xstate.atomicstatenodeconfig.md b/api/xstate/xstate.atomicstatenodeconfig.md new file mode 100644 index 000000000..7b32fd07a --- /dev/null +++ b/api/xstate/xstate.atomicstatenodeconfig.md @@ -0,0 +1,29 @@ +--- +title: "AtomicStateNodeConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AtomicStateNodeConfig interface + +**Signature:** + +```typescript +export interface AtomicStateNodeConfig extends StateNodeConfig +``` +**Extends:** [StateNodeConfig](./xstate.statenodeconfig.md)<><TContext, TEvent, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [initial?](./xstate.atomicstatenodeconfig.initial.md) | | undefined | _(Optional)_ | +| [onDone?](./xstate.atomicstatenodeconfig.ondone.md) | | undefined | _(Optional)_ | +| [parallel?](./xstate.atomicstatenodeconfig.parallel.md) | | false \| undefined | _(Optional)_ | +| [states?](./xstate.atomicstatenodeconfig.states.md) | | undefined | _(Optional)_ | + diff --git a/api/xstate/xstate.atomicstatenodeconfig.ondone.md b/api/xstate/xstate.atomicstatenodeconfig.ondone.md new file mode 100644 index 000000000..f3c4e28d4 --- /dev/null +++ b/api/xstate/xstate.atomicstatenodeconfig.ondone.md @@ -0,0 +1,18 @@ +--- +title: "onDone" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AtomicStateNodeConfig.onDone property + +**Signature:** + +```typescript +onDone?: undefined; +``` diff --git a/api/xstate/xstate.atomicstatenodeconfig.parallel.md b/api/xstate/xstate.atomicstatenodeconfig.parallel.md new file mode 100644 index 000000000..2deb11447 --- /dev/null +++ b/api/xstate/xstate.atomicstatenodeconfig.parallel.md @@ -0,0 +1,18 @@ +--- +title: "parallel" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AtomicStateNodeConfig.parallel property + +**Signature:** + +```typescript +parallel?: false | undefined; +``` diff --git a/api/xstate/xstate.atomicstatenodeconfig.states.md b/api/xstate/xstate.atomicstatenodeconfig.states.md new file mode 100644 index 000000000..c8d21c45e --- /dev/null +++ b/api/xstate/xstate.atomicstatenodeconfig.states.md @@ -0,0 +1,18 @@ +--- +title: "states" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## AtomicStateNodeConfig.states property + +**Signature:** + +```typescript +states?: undefined; +``` diff --git a/api/xstate/xstate.baseactorref.md b/api/xstate/xstate.baseactorref.md new file mode 100644 index 000000000..91c816c57 --- /dev/null +++ b/api/xstate/xstate.baseactorref.md @@ -0,0 +1,25 @@ +--- +title: "BaseActorRef" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## BaseActorRef interface + +**Signature:** + +```typescript +export interface BaseActorRef +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [send](./xstate.baseactorref.send.md) | | (event: TEvent) => void | | + diff --git a/api/xstate/xstate.baseactorref.send.md b/api/xstate/xstate.baseactorref.send.md new file mode 100644 index 000000000..b3738739d --- /dev/null +++ b/api/xstate/xstate.baseactorref.send.md @@ -0,0 +1,18 @@ +--- +title: "send" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## BaseActorRef.send property + +**Signature:** + +```typescript +send: (event: TEvent) => void; +``` diff --git a/api/xstate/xstate.callbackactorlogic.md b/api/xstate/xstate.callbackactorlogic.md new file mode 100644 index 000000000..0298e233d --- /dev/null +++ b/api/xstate/xstate.callbackactorlogic.md @@ -0,0 +1,20 @@ +--- +title: "CallbackActorLogic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## CallbackActorLogic type + +**Signature:** + +```typescript +export type CallbackActorLogic = ActorLogic, TEvent, TInput, HomomorphicOmit, '_receivers' | '_dispose'>, ActorSystem>; +``` +**References:** [EventObject](./xstate.eventobject.md)<>, [ActorLogic](./xstate.actorlogic.md)<>, [HomomorphicOmit](./xstate.homomorphicomit.md)<>, [ActorSystem](./xstate.actorsystem.md) + diff --git a/api/xstate/xstate.cancel.md b/api/xstate/xstate.cancel.md new file mode 100644 index 000000000..7ffbc5bfe --- /dev/null +++ b/api/xstate/xstate.cancel.md @@ -0,0 +1,31 @@ +--- +title: "cancel" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## cancel() function + +Cancels an in-flight `send(...)` action. A canceled sent action will not be executed, nor will its event be sent, unless it has already been sent (e.g., if `cancel(...)` is called after the `send(...)` action's `delay`<>). + +**Signature:** + +```typescript +export declare function cancel(sendId: ResolvableSendId): CancelAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| sendId | ResolvableSendId<TContext, TExpressionEvent, TExpressionAction, TEvent> | The id of the send(...) action to cancel. | + +**Returns:** + +[CancelAction](./xstate.cancelaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent> + diff --git a/api/xstate/xstate.cancelaction.md b/api/xstate/xstate.cancelaction.md new file mode 100644 index 000000000..f3d38618b --- /dev/null +++ b/api/xstate/xstate.cancelaction.md @@ -0,0 +1,18 @@ +--- +title: "CancelAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## CancelAction interface + +**Signature:** + +```typescript +export interface CancelAction +``` diff --git a/api/xstate/xstate.cast.md b/api/xstate/xstate.cast.md new file mode 100644 index 000000000..10eb43fc6 --- /dev/null +++ b/api/xstate/xstate.cast.md @@ -0,0 +1,18 @@ +--- +title: "Cast" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Cast type + +**Signature:** + +```typescript +export type Cast = A extends B ? A : B; +``` diff --git a/api/xstate/xstate.choose.md b/api/xstate/xstate.choose.md new file mode 100644 index 000000000..a727e4bbd --- /dev/null +++ b/api/xstate/xstate.choose.md @@ -0,0 +1,29 @@ +--- +title: "choose" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## choose() function + +**Signature:** + +```typescript +export declare function choose(branches: ReadonlyArray, NoInfer, TDelay>>): ChooseAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| branches | ReadonlyArray<[ChooseBranch](./xstate.choosebranch.md)<><TContext, TExpressionEvent, TEvent, TActor, [NoInfer](./xstate.noinfer.md)<><TAction>, [NoInfer](./xstate.noinfer.md)<><TGuard>, TDelay>> | | + +**Returns:** + +[ChooseAction](./xstate.chooseaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TActor, TAction, TGuard, TDelay> + diff --git a/api/xstate/xstate.chooseaction._out_taction.md b/api/xstate/xstate.chooseaction._out_taction.md new file mode 100644 index 000000000..af601d23c --- /dev/null +++ b/api/xstate/xstate.chooseaction._out_taction.md @@ -0,0 +1,18 @@ +--- +title: "_out_TAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ChooseAction.\_out\_TAction property + +**Signature:** + +```typescript +_out_TAction?: TAction; +``` diff --git a/api/xstate/xstate.chooseaction._out_tactor.md b/api/xstate/xstate.chooseaction._out_tactor.md new file mode 100644 index 000000000..b3618c0a3 --- /dev/null +++ b/api/xstate/xstate.chooseaction._out_tactor.md @@ -0,0 +1,18 @@ +--- +title: "_out_TActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ChooseAction.\_out\_TActor property + +**Signature:** + +```typescript +_out_TActor?: TActor; +``` diff --git a/api/xstate/xstate.chooseaction._out_tdelay.md b/api/xstate/xstate.chooseaction._out_tdelay.md new file mode 100644 index 000000000..c9333be41 --- /dev/null +++ b/api/xstate/xstate.chooseaction._out_tdelay.md @@ -0,0 +1,18 @@ +--- +title: "_out_TDelay" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ChooseAction.\_out\_TDelay property + +**Signature:** + +```typescript +_out_TDelay?: TDelay; +``` diff --git a/api/xstate/xstate.chooseaction._out_tguard.md b/api/xstate/xstate.chooseaction._out_tguard.md new file mode 100644 index 000000000..ae79ad11a --- /dev/null +++ b/api/xstate/xstate.chooseaction._out_tguard.md @@ -0,0 +1,18 @@ +--- +title: "_out_TGuard" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ChooseAction.\_out\_TGuard property + +**Signature:** + +```typescript +_out_TGuard?: TGuard; +``` diff --git a/api/xstate/xstate.chooseaction.md b/api/xstate/xstate.chooseaction.md new file mode 100644 index 000000000..7a5242203 --- /dev/null +++ b/api/xstate/xstate.chooseaction.md @@ -0,0 +1,28 @@ +--- +title: "ChooseAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ChooseAction interface + +**Signature:** + +```typescript +export interface ChooseAction +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_out\_TAction?](./xstate.chooseaction._out_taction.md) | | TAction | _(Optional)_ | +| [\_out\_TActor?](./xstate.chooseaction._out_tactor.md) | | TActor | _(Optional)_ | +| [\_out\_TDelay?](./xstate.chooseaction._out_tdelay.md) | | TDelay | _(Optional)_ | +| [\_out\_TGuard?](./xstate.chooseaction._out_tguard.md) | | TGuard | _(Optional)_ | + diff --git a/api/xstate/xstate.choosebranch.actions.md b/api/xstate/xstate.choosebranch.actions.md new file mode 100644 index 000000000..749f46524 --- /dev/null +++ b/api/xstate/xstate.choosebranch.actions.md @@ -0,0 +1,18 @@ +--- +title: "actions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ChooseBranch.actions property + +**Signature:** + +```typescript +actions: Actions; +``` diff --git a/api/xstate/xstate.choosebranch.guard.md b/api/xstate/xstate.choosebranch.guard.md new file mode 100644 index 000000000..a6b3ceb18 --- /dev/null +++ b/api/xstate/xstate.choosebranch.guard.md @@ -0,0 +1,18 @@ +--- +title: "guard" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ChooseBranch.guard property + +**Signature:** + +```typescript +guard?: Guard; +``` diff --git a/api/xstate/xstate.choosebranch.md b/api/xstate/xstate.choosebranch.md new file mode 100644 index 000000000..9b3140852 --- /dev/null +++ b/api/xstate/xstate.choosebranch.md @@ -0,0 +1,26 @@ +--- +title: "ChooseBranch" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ChooseBranch interface + +**Signature:** + +```typescript +export interface ChooseBranch +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actions](./xstate.choosebranch.actions.md) | | [Actions](./xstate.actions.md)<><TContext, TExpressionEvent, TEvent, undefined, TActor, TAction, TGuard, TDelay> | | +| [guard?](./xstate.choosebranch.guard.md) | | Guard<TContext, TExpressionEvent, undefined, TGuard> | _(Optional)_ | + diff --git a/api/xstate/xstate.compute.md b/api/xstate/xstate.compute.md new file mode 100644 index 000000000..0214ff352 --- /dev/null +++ b/api/xstate/xstate.compute.md @@ -0,0 +1,20 @@ +--- +title: "Compute" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Compute type + +**Signature:** + +```typescript +export type Compute = { + [K in keyof A]: A[K]; +} & unknown; +``` diff --git a/api/xstate/xstate.contextfactory.md b/api/xstate/xstate.contextfactory.md new file mode 100644 index 000000000..2f2dda248 --- /dev/null +++ b/api/xstate/xstate.contextfactory.md @@ -0,0 +1,23 @@ +--- +title: "ContextFactory" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ContextFactory type + +**Signature:** + +```typescript +export type ContextFactory = ({ spawn, input }: { + spawn: Spawner; + input: TInput; +}) => TContext; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [Spawner](./xstate.spawner.md) + diff --git a/api/xstate/xstate.contextfrom.md b/api/xstate/xstate.contextfrom.md new file mode 100644 index 000000000..6a2a32fbf --- /dev/null +++ b/api/xstate/xstate.contextfrom.md @@ -0,0 +1,20 @@ +--- +title: "ContextFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ContextFrom type + +**Signature:** + +```typescript +export type ContextFrom = ReturnTypeOrValue extends infer R ? R extends StateMachine ? TContext : R extends State ? TContext : R extends Actor ? TActorLogic extends StateMachine ? TContext : never : never : never; +``` +**References:** [StateMachine](./xstate.statemachine.md)<>, [State](./xstate.state.md)<>, [Actor](./xstate.actor.md) + diff --git a/api/xstate/xstate.createactor.md b/api/xstate/xstate.createactor.md new file mode 100644 index 000000000..2f7e47d42 --- /dev/null +++ b/api/xstate/xstate.createactor.md @@ -0,0 +1,32 @@ +--- +title: "createActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## createActor() function + +Creates a new `ActorRef` instance for the given machine with the provided options, if any. + +**Signature:** + +```typescript +export declare function createActor(machine: AreAllImplementationsAssumedToBeProvided extends true ? TMachine : MissingImplementationsError, options?: ActorOptions): Actor; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| machine | [AreAllImplementationsAssumedToBeProvided](./xstate.areallimplementationsassumedtobeprovided.md)<><TMachine\['\_\_TResolvedTypesMeta'\]> extends true ? TMachine : [MissingImplementationsError](./xstate.missingimplementationserror.md)<><TMachine\['\_\_TResolvedTypesMeta'\]> | The machine to create an actor from | +| options | [ActorOptions](./xstate.actoroptions.md)<><TMachine> | _(Optional)_ ActorRef options | + +**Returns:** + +[Actor](./xstate.actor.md)<><TMachine> + diff --git a/api/xstate/xstate.createactor_1.md b/api/xstate/xstate.createactor_1.md new file mode 100644 index 000000000..166313840 --- /dev/null +++ b/api/xstate/xstate.createactor_1.md @@ -0,0 +1,30 @@ +--- +title: "createActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## createActor() function + +**Signature:** + +```typescript +export declare function createActor(logic: TLogic, options?: ActorOptions): Actor; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| logic | TLogic | | +| options | [ActorOptions](./xstate.actoroptions.md)<><TLogic> | _(Optional)_ | + +**Returns:** + +[Actor](./xstate.actor.md)<><TLogic> + diff --git a/api/xstate/xstate.createemptyactor.md b/api/xstate/xstate.createemptyactor.md new file mode 100644 index 000000000..94be08953 --- /dev/null +++ b/api/xstate/xstate.createemptyactor.md @@ -0,0 +1,22 @@ +--- +title: "createEmptyActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## createEmptyActor() function + +**Signature:** + +```typescript +export declare function createEmptyActor(): ActorRef>; +``` +**Returns:** + +[ActorRef](./xstate.actorref.md)<><[AnyEventObject](./xstate.anyeventobject.md)<>, [Snapshot](./xstate.snapshot.md)<><undefined>> + diff --git a/api/xstate/xstate.createmachine.md b/api/xstate/xstate.createmachine.md new file mode 100644 index 000000000..42f52bc72 --- /dev/null +++ b/api/xstate/xstate.createmachine.md @@ -0,0 +1,31 @@ +--- +title: "createMachine" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## createMachine() function + +**Signature:** + +```typescript +export declare function createMachine(config: MachineConfig, implementations?: InternalMachineImplementations>): StateMachine['resolved'], 'tags'> & string, TInput, TOutput, ResolveTypegenMeta>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| config | [MachineConfig](./xstate.machineconfig.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay, TTag, TInput, TOutput, TTypesMeta> | | +| implementations | [InternalMachineImplementations](./xstate.internalmachineimplementations.md)<><TContext, TEvent, TActor, TAction, TDelay, [ResolveTypegenMeta](./xstate.resolvetypegenmeta.md)<><TTypesMeta, TEvent, TActor, TAction, TGuard, TDelay, TTag>> | _(Optional)_ | + +**Returns:** + +[StateMachine](./xstate.statemachine.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay, [Prop](./xstate.prop.md)<><[ResolveTypegenMeta](./xstate.resolvetypegenmeta.md)<><TTypesMeta, TEvent, TActor, TAction, TGuard, TDelay, TTag>\['resolved'\], 'tags'> & string, TInput, TOutput, [ResolveTypegenMeta](./xstate.resolvetypegenmeta.md)<><TTypesMeta, TEvent, TActor, TAction, TGuard, TDelay, TTag>> + diff --git a/api/xstate/xstate.delayconfig.md b/api/xstate/xstate.delayconfig.md new file mode 100644 index 000000000..e501f6039 --- /dev/null +++ b/api/xstate/xstate.delayconfig.md @@ -0,0 +1,20 @@ +--- +title: "DelayConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DelayConfig type + +**Signature:** + +```typescript +export type DelayConfig = number | DelayExpr; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [DelayExpr](./xstate.delayexpr.md) + diff --git a/api/xstate/xstate.delayedtransitiondefinition.delay.md b/api/xstate/xstate.delayedtransitiondefinition.delay.md new file mode 100644 index 000000000..574e0572f --- /dev/null +++ b/api/xstate/xstate.delayedtransitiondefinition.delay.md @@ -0,0 +1,18 @@ +--- +title: "delay" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DelayedTransitionDefinition.delay property + +**Signature:** + +```typescript +delay: number | string | DelayExpr; +``` diff --git a/api/xstate/xstate.delayedtransitiondefinition.md b/api/xstate/xstate.delayedtransitiondefinition.md new file mode 100644 index 000000000..386a5bf60 --- /dev/null +++ b/api/xstate/xstate.delayedtransitiondefinition.md @@ -0,0 +1,26 @@ +--- +title: "DelayedTransitionDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DelayedTransitionDefinition interface + +**Signature:** + +```typescript +export interface DelayedTransitionDefinition extends TransitionDefinition +``` +**Extends:** [TransitionDefinition](./xstate.transitiondefinition.md)<><TContext, TEvent> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [delay](./xstate.delayedtransitiondefinition.delay.md) | | number \| string \| [DelayExpr](./xstate.delayexpr.md)<><TContext, TEvent, undefined, TEvent> | | + diff --git a/api/xstate/xstate.delayedtransitions.md b/api/xstate/xstate.delayedtransitions.md new file mode 100644 index 000000000..f7df5ea84 --- /dev/null +++ b/api/xstate/xstate.delayedtransitions.md @@ -0,0 +1,22 @@ +--- +title: "DelayedTransitions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DelayedTransitions type + +**Signature:** + +```typescript +export type DelayedTransitions = { + [K in Delay]?: string | SingleOrArray>; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [SingleOrArray](./xstate.singleorarray.md)<>, [TransitionConfig](./xstate.transitionconfig.md) + diff --git a/api/xstate/xstate.delayexpr.md b/api/xstate/xstate.delayexpr.md new file mode 100644 index 000000000..7b6e46a31 --- /dev/null +++ b/api/xstate/xstate.delayexpr.md @@ -0,0 +1,20 @@ +--- +title: "DelayExpr" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DelayExpr type + +**Signature:** + +```typescript +export type DelayExpr = (args: ActionArgs) => number; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ActionArgs](./xstate.actionargs.md) + diff --git a/api/xstate/xstate.delayfunctionmap.md b/api/xstate/xstate.delayfunctionmap.md new file mode 100644 index 000000000..6624a5ed5 --- /dev/null +++ b/api/xstate/xstate.delayfunctionmap.md @@ -0,0 +1,20 @@ +--- +title: "DelayFunctionMap" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DelayFunctionMap type + +**Signature:** + +```typescript +export type DelayFunctionMap = Record>; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [DelayConfig](./xstate.delayconfig.md) + diff --git a/api/xstate/xstate.devtoolsadapter.md b/api/xstate/xstate.devtoolsadapter.md new file mode 100644 index 000000000..17e964d3a --- /dev/null +++ b/api/xstate/xstate.devtoolsadapter.md @@ -0,0 +1,20 @@ +--- +title: "DevToolsAdapter" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DevToolsAdapter type + +**Signature:** + +```typescript +export type DevToolsAdapter = (service: AnyActor) => void; +``` +**References:** [AnyActor](./xstate.anyactor.md) + diff --git a/api/xstate/xstate.doneactorevent.md b/api/xstate/xstate.doneactorevent.md new file mode 100644 index 000000000..58c4f14d7 --- /dev/null +++ b/api/xstate/xstate.doneactorevent.md @@ -0,0 +1,26 @@ +--- +title: "DoneActorEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DoneActorEvent interface + +**Signature:** + +```typescript +export interface DoneActorEvent +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [output](./xstate.doneactorevent.output.md) | | TOutput | | +| [type](./xstate.doneactorevent.type.md) | | \`xstate.done.actor.${string}\` | | + diff --git a/api/xstate/xstate.doneactorevent.output.md b/api/xstate/xstate.doneactorevent.output.md new file mode 100644 index 000000000..ee8de3ae0 --- /dev/null +++ b/api/xstate/xstate.doneactorevent.output.md @@ -0,0 +1,18 @@ +--- +title: "output" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DoneActorEvent.output property + +**Signature:** + +```typescript +output: TOutput; +``` diff --git a/api/xstate/xstate.doneactorevent.type.md b/api/xstate/xstate.doneactorevent.type.md new file mode 100644 index 000000000..fc100d027 --- /dev/null +++ b/api/xstate/xstate.doneactorevent.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DoneActorEvent.type property + +**Signature:** + +```typescript +type: `xstate.done.actor.${string}`; +``` diff --git a/api/xstate/xstate.donestateevent.md b/api/xstate/xstate.donestateevent.md new file mode 100644 index 000000000..f16fa7404 --- /dev/null +++ b/api/xstate/xstate.donestateevent.md @@ -0,0 +1,27 @@ +--- +title: "DoneStateEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DoneStateEvent interface + +**Signature:** + +```typescript +export interface DoneStateEvent extends EventObject +``` +**Extends:** [EventObject](./xstate.eventobject.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [output](./xstate.donestateevent.output.md) | | TOutput | | +| [type](./xstate.donestateevent.type.md) | | \`xstate.done.state.${string}\` | | + diff --git a/api/xstate/xstate.donestateevent.output.md b/api/xstate/xstate.donestateevent.output.md new file mode 100644 index 000000000..bb7897b2a --- /dev/null +++ b/api/xstate/xstate.donestateevent.output.md @@ -0,0 +1,18 @@ +--- +title: "output" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DoneStateEvent.output property + +**Signature:** + +```typescript +output: TOutput; +``` diff --git a/api/xstate/xstate.donestateevent.type.md b/api/xstate/xstate.donestateevent.type.md new file mode 100644 index 000000000..bfb13718d --- /dev/null +++ b/api/xstate/xstate.donestateevent.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## DoneStateEvent.type property + +**Signature:** + +```typescript +type: `xstate.done.state.${string}`; +``` diff --git a/api/xstate/xstate.equals.md b/api/xstate/xstate.equals.md new file mode 100644 index 000000000..95c28a9b0 --- /dev/null +++ b/api/xstate/xstate.equals.md @@ -0,0 +1,18 @@ +--- +title: "Equals" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Equals type + +**Signature:** + +```typescript +export type Equals = (() => A extends A2 ? true : false) extends () => A extends A1 ? true : false ? true : false; +``` diff --git a/api/xstate/xstate.erroractorevent.data.md b/api/xstate/xstate.erroractorevent.data.md new file mode 100644 index 000000000..50b982abb --- /dev/null +++ b/api/xstate/xstate.erroractorevent.data.md @@ -0,0 +1,18 @@ +--- +title: "data" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ErrorActorEvent.data property + +**Signature:** + +```typescript +data: TErrorData; +``` diff --git a/api/xstate/xstate.erroractorevent.md b/api/xstate/xstate.erroractorevent.md new file mode 100644 index 000000000..9f6beb529 --- /dev/null +++ b/api/xstate/xstate.erroractorevent.md @@ -0,0 +1,27 @@ +--- +title: "ErrorActorEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ErrorActorEvent interface + +**Signature:** + +```typescript +export interface ErrorActorEvent extends EventObject +``` +**Extends:** [EventObject](./xstate.eventobject.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [data](./xstate.erroractorevent.data.md) | | TErrorData | | +| [type](./xstate.erroractorevent.type.md) | | \`xstate.error.actor.${string}\` | | + diff --git a/api/xstate/xstate.erroractorevent.type.md b/api/xstate/xstate.erroractorevent.type.md new file mode 100644 index 000000000..eb3ff5dfd --- /dev/null +++ b/api/xstate/xstate.erroractorevent.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ErrorActorEvent.type property + +**Signature:** + +```typescript +type: `xstate.error.actor.${string}`; +``` diff --git a/api/xstate/xstate.escalate.md b/api/xstate/xstate.escalate.md new file mode 100644 index 000000000..accd30b3e --- /dev/null +++ b/api/xstate/xstate.escalate.md @@ -0,0 +1,32 @@ +--- +title: "escalate" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## escalate() function + +Escalates an error by sending it as an event to this machine's parent. + +**Signature:** + +```typescript +export declare function escalate(errorData: TErrorData | ((args: UnifiedArg) => TErrorData), options?: SendToActionParams): SendToAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| errorData | TErrorData \| ((args: [UnifiedArg](./xstate.unifiedarg.md)<><TContext, TExpressionEvent, TEvent>) => TErrorData) | The error data to send, or the expression function that takes in the context, event, and meta, and returns the error data to send. | +| options | [SendToActionParams](./xstate.sendtoactionparams.md)<><TContext, TExpressionEvent, TExpressionAction, [EventObject](./xstate.eventobject.md)<>, TEvent, string> | _(Optional)_ Options to pass into the send action creator. | + +**Returns:** + +[SendToAction](./xstate.sendtoaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, string> + diff --git a/api/xstate/xstate.eventdescriptor.md b/api/xstate/xstate.eventdescriptor.md new file mode 100644 index 000000000..6dec35b72 --- /dev/null +++ b/api/xstate/xstate.eventdescriptor.md @@ -0,0 +1,20 @@ +--- +title: "EventDescriptor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## EventDescriptor type + +**Signature:** + +```typescript +export type EventDescriptor = TEvent['type'] | PartialEventDescriptor | '*'; +``` +**References:** [EventObject](./xstate.eventobject.md) + diff --git a/api/xstate/xstate.eventfrom.md b/api/xstate/xstate.eventfrom.md new file mode 100644 index 000000000..b8edce279 --- /dev/null +++ b/api/xstate/xstate.eventfrom.md @@ -0,0 +1,20 @@ +--- +title: "EventFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## EventFrom type + +**Signature:** + +```typescript +export type EventFrom = never, TEvent extends EventObject = ResolveEventType> = IsNever extends true ? TEvent : ExtractEvent; +``` +**References:** [Prop](./xstate.prop.md)<>, [EventObject](./xstate.eventobject.md)<>, [IsNever](./xstate.isnever.md)<>, [ExtractEvent](./xstate.extractevent.md) + diff --git a/api/xstate/xstate.eventfromlogic.md b/api/xstate/xstate.eventfromlogic.md new file mode 100644 index 000000000..8ae57996d --- /dev/null +++ b/api/xstate/xstate.eventfromlogic.md @@ -0,0 +1,20 @@ +--- +title: "EventFromLogic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## EventFromLogic type + +**Signature:** + +```typescript +export type EventFromLogic> = TLogic extends ActorLogic ? TEvent : never; +``` +**References:** [ActorLogic](./xstate.actorlogic.md) + diff --git a/api/xstate/xstate.eventobject.md b/api/xstate/xstate.eventobject.md new file mode 100644 index 000000000..d3d4c73e9 --- /dev/null +++ b/api/xstate/xstate.eventobject.md @@ -0,0 +1,27 @@ +--- +title: "EventObject" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## EventObject interface + +The full definition of an event, with a string `type`<>. + +**Signature:** + +```typescript +export interface EventObject +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [type](./xstate.eventobject.type.md) | | string | The type of event that is sent. | + diff --git a/api/xstate/xstate.eventobject.type.md b/api/xstate/xstate.eventobject.type.md new file mode 100644 index 000000000..fc543d182 --- /dev/null +++ b/api/xstate/xstate.eventobject.type.md @@ -0,0 +1,20 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## EventObject.type property + +The type of event that is sent. + +**Signature:** + +```typescript +type: string; +``` diff --git a/api/xstate/xstate.extractevent.md b/api/xstate/xstate.extractevent.md new file mode 100644 index 000000000..55bf243ed --- /dev/null +++ b/api/xstate/xstate.extractevent.md @@ -0,0 +1,20 @@ +--- +title: "ExtractEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ExtractEvent type + +**Signature:** + +```typescript +export type ExtractEvent> = string extends TEvent['type'] ? TEvent : NormalizeDescriptor extends infer TNormalizedDescriptor ? TEvent extends any ? TEvent['type'] extends TNormalizedDescriptor ? TEvent : never : never : never; +``` +**References:** [EventObject](./xstate.eventobject.md)<>, [EventDescriptor](./xstate.eventdescriptor.md) + diff --git a/api/xstate/xstate.forwardto.md b/api/xstate/xstate.forwardto.md new file mode 100644 index 000000000..21befa5ed --- /dev/null +++ b/api/xstate/xstate.forwardto.md @@ -0,0 +1,32 @@ +--- +title: "forwardTo" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## forwardTo() function + +Forwards (sends) an event to a specified service. + +**Signature:** + +```typescript +export declare function forwardTo(target: Target, options?: SendToActionOptions): SendToAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| target | Target<TContext, TExpressionEvent, TExpressionAction, TEvent> | The target service to forward the event to. | +| options | [SendToActionOptions](./xstate.sendtoactionoptions.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> | _(Optional)_ Options to pass into the send action creator. | + +**Returns:** + +[SendToAction](./xstate.sendtoaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> + diff --git a/api/xstate/xstate.fromcallback.md b/api/xstate/xstate.fromcallback.md new file mode 100644 index 000000000..195516217 --- /dev/null +++ b/api/xstate/xstate.fromcallback.md @@ -0,0 +1,29 @@ +--- +title: "fromCallback" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## fromCallback() function + +**Signature:** + +```typescript +export declare function fromCallback(invokeCallback: InvokeCallback): CallbackActorLogic; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| invokeCallback | InvokeCallback<TEvent, [AnyEventObject](./xstate.anyeventobject.md)<>, TInput> | | + +**Returns:** + +[CallbackActorLogic](./xstate.callbackactorlogic.md)<><TEvent, TInput> + diff --git a/api/xstate/xstate.fromeventobservable.md b/api/xstate/xstate.fromeventobservable.md new file mode 100644 index 000000000..7eff0e028 --- /dev/null +++ b/api/xstate/xstate.fromeventobservable.md @@ -0,0 +1,37 @@ +--- +title: "fromEventObservable" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## fromEventObservable() function + +Creates event observable logic that listens to an observable that delivers event objects. + +**Signature:** + +```typescript +export declare function fromEventObservable(lazyObservable: ({ input, system }: { + input: TInput; + system: AnyActorSystem; + self: ObservableActorRef; +}) => Subscribable): ObservableActorLogic; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| lazyObservable | ({ input, system }: { input: TInput; system: [AnyActorSystem](./xstate.anyactorsystem.md)<>; self: ObservableActorRef<T>; }) => [Subscribable](./xstate.subscribable.md)<><T> | A function that creates an observable | + +**Returns:** + +[ObservableActorLogic](./xstate.observableactorlogic.md)<><T, TInput> + +Event observable logic + diff --git a/api/xstate/xstate.fromobservable.md b/api/xstate/xstate.fromobservable.md new file mode 100644 index 000000000..0b486cf9e --- /dev/null +++ b/api/xstate/xstate.fromobservable.md @@ -0,0 +1,33 @@ +--- +title: "fromObservable" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## fromObservable() function + +**Signature:** + +```typescript +export declare function fromObservable(observableCreator: ({ input, system }: { + input: TInput; + system: AnyActorSystem; + self: ObservableActorRef; +}) => Subscribable): ObservableActorLogic; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| observableCreator | ({ input, system }: { input: TInput; system: [AnyActorSystem](./xstate.anyactorsystem.md)<>; self: ObservableActorRef<TContext>; }) => [Subscribable](./xstate.subscribable.md)<><TContext> | | + +**Returns:** + +[ObservableActorLogic](./xstate.observableactorlogic.md)<><TContext, TInput> + diff --git a/api/xstate/xstate.frompromise.md b/api/xstate/xstate.frompromise.md new file mode 100644 index 000000000..257b8720f --- /dev/null +++ b/api/xstate/xstate.frompromise.md @@ -0,0 +1,33 @@ +--- +title: "fromPromise" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## fromPromise() function + +**Signature:** + +```typescript +export declare function fromPromise(promiseCreator: ({ input, system }: { + input: TInput; + system: AnyActorSystem; + self: PromiseActorRef; +}) => PromiseLike): PromiseActorLogic; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| promiseCreator | ({ input, system }: { input: TInput; system: [AnyActorSystem](./xstate.anyactorsystem.md)<>; self: PromiseActorRef<TOutput>; }) => PromiseLike<TOutput> | | + +**Returns:** + +[PromiseActorLogic](./xstate.promiseactorlogic.md)<><TOutput, TInput> + diff --git a/api/xstate/xstate.fromtransition.md b/api/xstate/xstate.fromtransition.md new file mode 100644 index 000000000..8e0b7c4f1 --- /dev/null +++ b/api/xstate/xstate.fromtransition.md @@ -0,0 +1,39 @@ +--- +title: "fromTransition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## fromTransition() function + +Returns actor logic from a transition function and its initial state. + +A transition function is a function that takes the current state and an event and returns the next state. + +**Signature:** + +```typescript +export declare function fromTransition, TInput>(transition: (state: TContext, event: TEvent, actorContext: ActorContext, TEvent, TSystem>) => TContext, initialContext: TContext | (({ input, self }: { + input: TInput; + self: TransitionActorRef; +}) => TContext)): TransitionActorLogic; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| transition | (state: TContext, event: TEvent, actorContext: [ActorContext](./xstate.actorcontext.md)<><[TransitionSnapshot](./xstate.transitionsnapshot.md)<><TContext>, TEvent, TSystem>) => TContext | The transition function that returns the next state given the current state and event. | +| initialContext | TContext \| (({ input, self }: { input: TInput; self: TransitionActorRef<TContext, TEvent>; }) => TContext) | The initial state of the transition function. | + +**Returns:** + +[TransitionActorLogic](./xstate.transitionactorlogic.md)<><TContext, TEvent, TInput> + +Actor logic + diff --git a/api/xstate/xstate.getstatenodes.md b/api/xstate/xstate.getstatenodes.md new file mode 100644 index 000000000..df0931092 --- /dev/null +++ b/api/xstate/xstate.getstatenodes.md @@ -0,0 +1,32 @@ +--- +title: "getStateNodes" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## getStateNodes() function + +Returns the state nodes represented by the current state value. + +**Signature:** + +```typescript +export declare function getStateNodes(stateNode: AnyStateNode, state: StateValue | State): Array; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stateNode | [AnyStateNode](./xstate.anystatenode.md) | | +| state | [StateValue](./xstate.statevalue.md) \| [State](./xstate.state.md)<><TContext, TEvent, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>> | The state value or State instance | + +**Returns:** + +Array<[AnyStateNode](./xstate.anystatenode.md)<>> + diff --git a/api/xstate/xstate.historystatenode.history.md b/api/xstate/xstate.historystatenode.history.md new file mode 100644 index 000000000..c1f19afb4 --- /dev/null +++ b/api/xstate/xstate.historystatenode.history.md @@ -0,0 +1,18 @@ +--- +title: "history" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HistoryStateNode.history property + +**Signature:** + +```typescript +history: 'shallow' | 'deep'; +``` diff --git a/api/xstate/xstate.historystatenode.md b/api/xstate/xstate.historystatenode.md new file mode 100644 index 000000000..0ebfb4784 --- /dev/null +++ b/api/xstate/xstate.historystatenode.md @@ -0,0 +1,27 @@ +--- +title: "HistoryStateNode" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HistoryStateNode interface + +**Signature:** + +```typescript +export interface HistoryStateNode extends StateNode +``` +**Extends:** [StateNode](./xstate.statenode.md)<><TContext> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [history](./xstate.historystatenode.history.md) | | 'shallow' \| 'deep' | | +| [target](./xstate.historystatenode.target.md) | | string \| undefined | | + diff --git a/api/xstate/xstate.historystatenode.target.md b/api/xstate/xstate.historystatenode.target.md new file mode 100644 index 000000000..f4470312c --- /dev/null +++ b/api/xstate/xstate.historystatenode.target.md @@ -0,0 +1,18 @@ +--- +title: "target" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HistoryStateNode.target property + +**Signature:** + +```typescript +target: string | undefined; +``` diff --git a/api/xstate/xstate.historystatenodeconfig.history.md b/api/xstate/xstate.historystatenodeconfig.history.md new file mode 100644 index 000000000..5e91772d0 --- /dev/null +++ b/api/xstate/xstate.historystatenodeconfig.history.md @@ -0,0 +1,18 @@ +--- +title: "history" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HistoryStateNodeConfig.history property + +**Signature:** + +```typescript +history: 'shallow' | 'deep' | true; +``` diff --git a/api/xstate/xstate.historystatenodeconfig.md b/api/xstate/xstate.historystatenodeconfig.md new file mode 100644 index 000000000..80f17b6f7 --- /dev/null +++ b/api/xstate/xstate.historystatenodeconfig.md @@ -0,0 +1,27 @@ +--- +title: "HistoryStateNodeConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HistoryStateNodeConfig interface + +**Signature:** + +```typescript +export interface HistoryStateNodeConfig extends AtomicStateNodeConfig +``` +**Extends:** [AtomicStateNodeConfig](./xstate.atomicstatenodeconfig.md)<><TContext, TEvent> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [history](./xstate.historystatenodeconfig.history.md) | | 'shallow' \| 'deep' \| true | | +| [target](./xstate.historystatenodeconfig.target.md) | | string \| undefined | | + diff --git a/api/xstate/xstate.historystatenodeconfig.target.md b/api/xstate/xstate.historystatenodeconfig.target.md new file mode 100644 index 000000000..88ab71eae --- /dev/null +++ b/api/xstate/xstate.historystatenodeconfig.target.md @@ -0,0 +1,18 @@ +--- +title: "target" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HistoryStateNodeConfig.target property + +**Signature:** + +```typescript +target: string | undefined; +``` diff --git a/api/xstate/xstate.historyvalue.md b/api/xstate/xstate.historyvalue.md new file mode 100644 index 000000000..d5c1ec4df --- /dev/null +++ b/api/xstate/xstate.historyvalue.md @@ -0,0 +1,20 @@ +--- +title: "HistoryValue" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HistoryValue type + +**Signature:** + +```typescript +export type HistoryValue = Record>>; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [StateNode](./xstate.statenode.md) + diff --git a/api/xstate/xstate.homomorphicomit.md b/api/xstate/xstate.homomorphicomit.md new file mode 100644 index 000000000..b5ad04c55 --- /dev/null +++ b/api/xstate/xstate.homomorphicomit.md @@ -0,0 +1,20 @@ +--- +title: "HomomorphicOmit" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HomomorphicOmit type + +**Signature:** + +```typescript +export type HomomorphicOmit = { + [P in keyof T as Exclude]: T[P]; +}; +``` diff --git a/api/xstate/xstate.homomorphicpick.md b/api/xstate/xstate.homomorphicpick.md new file mode 100644 index 000000000..2a9120840 --- /dev/null +++ b/api/xstate/xstate.homomorphicpick.md @@ -0,0 +1,20 @@ +--- +title: "HomomorphicPick" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## HomomorphicPick type + +**Signature:** + +```typescript +export type HomomorphicPick = { + [P in keyof T as P & K]: T[P]; +}; +``` diff --git a/api/xstate/xstate.indexbyprop.md b/api/xstate/xstate.indexbyprop.md new file mode 100644 index 000000000..6a21fc761 --- /dev/null +++ b/api/xstate/xstate.indexbyprop.md @@ -0,0 +1,20 @@ +--- +title: "IndexByProp" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## IndexByProp type + +**Signature:** + +```typescript +export type IndexByProp, P extends keyof T> = { + [E in T as E[P]]: E; +}; +``` diff --git a/api/xstate/xstate.indexbytype.md b/api/xstate/xstate.indexbytype.md new file mode 100644 index 000000000..1aa416ee4 --- /dev/null +++ b/api/xstate/xstate.indexbytype.md @@ -0,0 +1,22 @@ +--- +title: "IndexByType" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## IndexByType type + +**Signature:** + +```typescript +export type IndexByType = IndexByProp; +``` +**References:** [IndexByProp](./xstate.indexbyprop.md) + diff --git a/api/xstate/xstate.inferevent.md b/api/xstate/xstate.inferevent.md new file mode 100644 index 000000000..af50ab24c --- /dev/null +++ b/api/xstate/xstate.inferevent.md @@ -0,0 +1,26 @@ +--- +title: "InferEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InferEvent type + +**Signature:** + +```typescript +export type InferEvent = { + [T in E['type']]: { + type: T; + } & Extract; +}[E['type']]; +``` +**References:** [EventObject](./xstate.eventobject.md) + diff --git a/api/xstate/xstate.initialtransitionconfig.md b/api/xstate/xstate.initialtransitionconfig.md new file mode 100644 index 000000000..30de0bad0 --- /dev/null +++ b/api/xstate/xstate.initialtransitionconfig.md @@ -0,0 +1,26 @@ +--- +title: "InitialTransitionConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InitialTransitionConfig interface + +**Signature:** + +```typescript +export interface InitialTransitionConfig extends TransitionConfig +``` +**Extends:** [TransitionConfig](./xstate.transitionconfig.md)<><TContext, TEvent, TEvent, TActor, TAction, TGuard, TDelay> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [target](./xstate.initialtransitionconfig.target.md) | | string | | + diff --git a/api/xstate/xstate.initialtransitionconfig.target.md b/api/xstate/xstate.initialtransitionconfig.target.md new file mode 100644 index 000000000..de171125c --- /dev/null +++ b/api/xstate/xstate.initialtransitionconfig.target.md @@ -0,0 +1,18 @@ +--- +title: "target" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InitialTransitionConfig.target property + +**Signature:** + +```typescript +target: string; +``` diff --git a/api/xstate/xstate.initialtransitiondefinition.guard.md b/api/xstate/xstate.initialtransitiondefinition.guard.md new file mode 100644 index 000000000..279faab02 --- /dev/null +++ b/api/xstate/xstate.initialtransitiondefinition.guard.md @@ -0,0 +1,18 @@ +--- +title: "guard" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InitialTransitionDefinition.guard property + +**Signature:** + +```typescript +guard?: never; +``` diff --git a/api/xstate/xstate.initialtransitiondefinition.md b/api/xstate/xstate.initialtransitiondefinition.md new file mode 100644 index 000000000..f5b34c0ec --- /dev/null +++ b/api/xstate/xstate.initialtransitiondefinition.md @@ -0,0 +1,27 @@ +--- +title: "InitialTransitionDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InitialTransitionDefinition interface + +**Signature:** + +```typescript +export interface InitialTransitionDefinition extends TransitionDefinition +``` +**Extends:** [TransitionDefinition](./xstate.transitiondefinition.md)<><TContext, TEvent> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [guard?](./xstate.initialtransitiondefinition.guard.md) | | never | _(Optional)_ | +| [target](./xstate.initialtransitiondefinition.target.md) | | ReadonlyArray<[StateNode](./xstate.statenode.md)<><TContext, TEvent>> | | + diff --git a/api/xstate/xstate.initialtransitiondefinition.target.md b/api/xstate/xstate.initialtransitiondefinition.target.md new file mode 100644 index 000000000..5277a9d88 --- /dev/null +++ b/api/xstate/xstate.initialtransitiondefinition.target.md @@ -0,0 +1,18 @@ +--- +title: "target" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InitialTransitionDefinition.target property + +**Signature:** + +```typescript +target: ReadonlyArray>; +``` diff --git a/api/xstate/xstate.inputfrom.md b/api/xstate/xstate.inputfrom.md new file mode 100644 index 000000000..4e3a90fc6 --- /dev/null +++ b/api/xstate/xstate.inputfrom.md @@ -0,0 +1,20 @@ +--- +title: "InputFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InputFrom type + +**Signature:** + +```typescript +export type InputFrom = T extends StateMachine ? TInput : T extends ActorLogic ? TInput : never; +``` +**References:** [AnyActorLogic](./xstate.anyactorlogic.md)<>, [StateMachine](./xstate.statemachine.md)<>, [ActorLogic](./xstate.actorlogic.md) + diff --git a/api/xstate/xstate.inspectedactorevent.actorref.md b/api/xstate/xstate.inspectedactorevent.actorref.md new file mode 100644 index 000000000..bf135beaf --- /dev/null +++ b/api/xstate/xstate.inspectedactorevent.actorref.md @@ -0,0 +1,18 @@ +--- +title: "actorRef" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedActorEvent.actorRef property + +**Signature:** + +```typescript +actorRef: AnyActorRef; +``` diff --git a/api/xstate/xstate.inspectedactorevent.md b/api/xstate/xstate.inspectedactorevent.md new file mode 100644 index 000000000..c50988a5f --- /dev/null +++ b/api/xstate/xstate.inspectedactorevent.md @@ -0,0 +1,27 @@ +--- +title: "InspectedActorEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedActorEvent interface + +**Signature:** + +```typescript +export interface InspectedActorEvent extends BaseInspectionEventProperties +``` +**Extends:** BaseInspectionEventProperties + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actorRef](./xstate.inspectedactorevent.actorref.md) | | [AnyActorRef](./xstate.anyactorref.md) | | +| [type](./xstate.inspectedactorevent.type.md) | | '@xstate.actor' | | + diff --git a/api/xstate/xstate.inspectedactorevent.type.md b/api/xstate/xstate.inspectedactorevent.type.md new file mode 100644 index 000000000..8b186cf69 --- /dev/null +++ b/api/xstate/xstate.inspectedactorevent.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedActorEvent.type property + +**Signature:** + +```typescript +type: '@xstate.actor'; +``` diff --git a/api/xstate/xstate.inspectedeventevent.event.md b/api/xstate/xstate.inspectedeventevent.event.md new file mode 100644 index 000000000..4fff6f3b6 --- /dev/null +++ b/api/xstate/xstate.inspectedeventevent.event.md @@ -0,0 +1,18 @@ +--- +title: "event" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedEventEvent.event property + +**Signature:** + +```typescript +event: AnyEventObject; +``` diff --git a/api/xstate/xstate.inspectedeventevent.md b/api/xstate/xstate.inspectedeventevent.md new file mode 100644 index 000000000..599e7d0c8 --- /dev/null +++ b/api/xstate/xstate.inspectedeventevent.md @@ -0,0 +1,29 @@ +--- +title: "InspectedEventEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedEventEvent interface + +**Signature:** + +```typescript +export interface InspectedEventEvent extends BaseInspectionEventProperties +``` +**Extends:** BaseInspectionEventProperties + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [event](./xstate.inspectedeventevent.event.md) | | [AnyEventObject](./xstate.anyeventobject.md) | | +| [sourceRef](./xstate.inspectedeventevent.sourceref.md) | | [AnyActorRef](./xstate.anyactorref.md) \| undefined | | +| [targetRef](./xstate.inspectedeventevent.targetref.md) | | [AnyActorRef](./xstate.anyactorref.md) | | +| [type](./xstate.inspectedeventevent.type.md) | | '@xstate.event' | | + diff --git a/api/xstate/xstate.inspectedeventevent.sourceref.md b/api/xstate/xstate.inspectedeventevent.sourceref.md new file mode 100644 index 000000000..e79a58948 --- /dev/null +++ b/api/xstate/xstate.inspectedeventevent.sourceref.md @@ -0,0 +1,18 @@ +--- +title: "sourceRef" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedEventEvent.sourceRef property + +**Signature:** + +```typescript +sourceRef: AnyActorRef | undefined; +``` diff --git a/api/xstate/xstate.inspectedeventevent.targetref.md b/api/xstate/xstate.inspectedeventevent.targetref.md new file mode 100644 index 000000000..eb2b39f0e --- /dev/null +++ b/api/xstate/xstate.inspectedeventevent.targetref.md @@ -0,0 +1,18 @@ +--- +title: "targetRef" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedEventEvent.targetRef property + +**Signature:** + +```typescript +targetRef: AnyActorRef; +``` diff --git a/api/xstate/xstate.inspectedeventevent.type.md b/api/xstate/xstate.inspectedeventevent.type.md new file mode 100644 index 000000000..7585520c2 --- /dev/null +++ b/api/xstate/xstate.inspectedeventevent.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedEventEvent.type property + +**Signature:** + +```typescript +type: '@xstate.event'; +``` diff --git a/api/xstate/xstate.inspectedsnapshotevent.actorref.md b/api/xstate/xstate.inspectedsnapshotevent.actorref.md new file mode 100644 index 000000000..8ba21dcc5 --- /dev/null +++ b/api/xstate/xstate.inspectedsnapshotevent.actorref.md @@ -0,0 +1,18 @@ +--- +title: "actorRef" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedSnapshotEvent.actorRef property + +**Signature:** + +```typescript +actorRef: AnyActorRef; +``` diff --git a/api/xstate/xstate.inspectedsnapshotevent.event.md b/api/xstate/xstate.inspectedsnapshotevent.event.md new file mode 100644 index 000000000..4931b3edf --- /dev/null +++ b/api/xstate/xstate.inspectedsnapshotevent.event.md @@ -0,0 +1,18 @@ +--- +title: "event" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedSnapshotEvent.event property + +**Signature:** + +```typescript +event: AnyEventObject; +``` diff --git a/api/xstate/xstate.inspectedsnapshotevent.md b/api/xstate/xstate.inspectedsnapshotevent.md new file mode 100644 index 000000000..5a24e351b --- /dev/null +++ b/api/xstate/xstate.inspectedsnapshotevent.md @@ -0,0 +1,29 @@ +--- +title: "InspectedSnapshotEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedSnapshotEvent interface + +**Signature:** + +```typescript +export interface InspectedSnapshotEvent extends BaseInspectionEventProperties +``` +**Extends:** BaseInspectionEventProperties + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actorRef](./xstate.inspectedsnapshotevent.actorref.md) | | [AnyActorRef](./xstate.anyactorref.md) | | +| [event](./xstate.inspectedsnapshotevent.event.md) | | [AnyEventObject](./xstate.anyeventobject.md) | | +| [snapshot](./xstate.inspectedsnapshotevent.snapshot.md) | | [Snapshot](./xstate.snapshot.md)<><unknown> | | +| [type](./xstate.inspectedsnapshotevent.type.md) | | '@xstate.snapshot' | | + diff --git a/api/xstate/xstate.inspectedsnapshotevent.snapshot.md b/api/xstate/xstate.inspectedsnapshotevent.snapshot.md new file mode 100644 index 000000000..ee9dee182 --- /dev/null +++ b/api/xstate/xstate.inspectedsnapshotevent.snapshot.md @@ -0,0 +1,18 @@ +--- +title: "snapshot" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedSnapshotEvent.snapshot property + +**Signature:** + +```typescript +snapshot: Snapshot; +``` diff --git a/api/xstate/xstate.inspectedsnapshotevent.type.md b/api/xstate/xstate.inspectedsnapshotevent.type.md new file mode 100644 index 000000000..d24689884 --- /dev/null +++ b/api/xstate/xstate.inspectedsnapshotevent.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectedSnapshotEvent.type property + +**Signature:** + +```typescript +type: '@xstate.snapshot'; +``` diff --git a/api/xstate/xstate.inspectionevent.md b/api/xstate/xstate.inspectionevent.md new file mode 100644 index 000000000..69dbe75ee --- /dev/null +++ b/api/xstate/xstate.inspectionevent.md @@ -0,0 +1,20 @@ +--- +title: "InspectionEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InspectionEvent type + +**Signature:** + +```typescript +export type InspectionEvent = InspectedSnapshotEvent | InspectedEventEvent | InspectedActorEvent; +``` +**References:** [InspectedSnapshotEvent](./xstate.inspectedsnapshotevent.md)<>, [InspectedEventEvent](./xstate.inspectedeventevent.md)<>, [InspectedActorEvent](./xstate.inspectedactorevent.md) + diff --git a/api/xstate/xstate.internalmachineimplementations.md b/api/xstate/xstate.internalmachineimplementations.md new file mode 100644 index 000000000..bd35fd9f7 --- /dev/null +++ b/api/xstate/xstate.internalmachineimplementations.md @@ -0,0 +1,20 @@ +--- +title: "InternalMachineImplementations" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InternalMachineImplementations type + +**Signature:** + +```typescript +export type InternalMachineImplementations, 'missingImplementations'>> = Compute & GenerateActorsImplementationsPart & GenerateDelaysImplementationsPart & GenerateGuardsImplementationsPart>; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [Prop](./xstate.prop.md)<>, [Compute](./xstate.compute.md) + diff --git a/api/xstate/xstate.interopobservable._symbol.observable_.md b/api/xstate/xstate.interopobservable._symbol.observable_.md new file mode 100644 index 000000000..a5fd70e89 --- /dev/null +++ b/api/xstate/xstate.interopobservable._symbol.observable_.md @@ -0,0 +1,18 @@ +--- +title: "[Symbol.observable]" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InteropObservable.\[Symbol.observable\] property + +**Signature:** + +```typescript +[Symbol.observable]: () => InteropSubscribable; +``` diff --git a/api/xstate/xstate.interopobservable.md b/api/xstate/xstate.interopobservable.md new file mode 100644 index 000000000..8cdd5adad --- /dev/null +++ b/api/xstate/xstate.interopobservable.md @@ -0,0 +1,25 @@ +--- +title: "InteropObservable" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InteropObservable interface + +**Signature:** + +```typescript +export interface InteropObservable +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\[Symbol.observable\]](./xstate.interopobservable._symbol.observable_.md) | | () => [InteropSubscribable](./xstate.interopsubscribable.md)<><T> | | + diff --git a/api/xstate/xstate.interopsubscribable.md b/api/xstate/xstate.interopsubscribable.md new file mode 100644 index 000000000..88921f4c6 --- /dev/null +++ b/api/xstate/xstate.interopsubscribable.md @@ -0,0 +1,25 @@ +--- +title: "InteropSubscribable" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InteropSubscribable interface + +**Signature:** + +```typescript +export interface InteropSubscribable +``` + +## Methods + +| Method | Description | +| --- | --- | +| [subscribe(observer)](./xstate.interopsubscribable.subscribe.md) | | + diff --git a/api/xstate/xstate.interopsubscribable.subscribe.md b/api/xstate/xstate.interopsubscribable.subscribe.md new file mode 100644 index 000000000..99ebc0c72 --- /dev/null +++ b/api/xstate/xstate.interopsubscribable.subscribe.md @@ -0,0 +1,29 @@ +--- +title: "subscribe" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InteropSubscribable.subscribe() method + +**Signature:** + +```typescript +subscribe(observer: Observer): Subscription; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| observer | [Observer](./xstate.observer.md)<><T> | | + +**Returns:** + +[Subscription](./xstate.subscription.md) + diff --git a/api/xstate/xstate.interpret.md b/api/xstate/xstate.interpret.md new file mode 100644 index 000000000..5701819eb --- /dev/null +++ b/api/xstate/xstate.interpret.md @@ -0,0 +1,25 @@ +--- +title: "interpret" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## interpret variable + +> Warning: This API is now obsolete. +> +> Use `createActor` instead +> + +Creates a new Interpreter instance for the given machine with the provided options, if any. + +**Signature:** + +```typescript +interpret: typeof createActor +``` diff --git a/api/xstate/xstate.interpreter.md b/api/xstate/xstate.interpreter.md new file mode 100644 index 000000000..69f0eb54a --- /dev/null +++ b/api/xstate/xstate.interpreter.md @@ -0,0 +1,25 @@ +--- +title: "Interpreter" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Interpreter type + +> Warning: This API is now obsolete. +> +> Use `Actor` instead. +> + +**Signature:** + +```typescript +export type Interpreter = typeof Actor; +``` +**References:** [Actor](./xstate.actor.md) + diff --git a/api/xstate/xstate.interpreterfrom.md b/api/xstate/xstate.interpreterfrom.md new file mode 100644 index 000000000..a3c2b5d8b --- /dev/null +++ b/api/xstate/xstate.interpreterfrom.md @@ -0,0 +1,25 @@ +--- +title: "InterpreterFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InterpreterFrom type + +> Warning: This API is now obsolete. +> +> Use `Actor` instead. +> + +**Signature:** + +```typescript +export type InterpreterFrom AnyStateMachine)> = ReturnTypeOrValue extends StateMachine ? Actor, TEvent, TInput, PersistedMachineState, ActorSystem>> : never; +``` +**References:** [AnyStateMachine](./xstate.anystatemachine.md)<>, [StateMachine](./xstate.statemachine.md)<>, [Actor](./xstate.actor.md)<>, [ActorLogic](./xstate.actorlogic.md)<>, [MachineSnapshot](./xstate.machinesnapshot.md)<>, [PersistedMachineState](./xstate.persistedmachinestate.md)<>, [ActorSystem](./xstate.actorsystem.md) + diff --git a/api/xstate/xstate.interpreterstatus.md b/api/xstate/xstate.interpreterstatus.md new file mode 100644 index 000000000..599e3c6c6 --- /dev/null +++ b/api/xstate/xstate.interpreterstatus.md @@ -0,0 +1,23 @@ +--- +title: "InterpreterStatus" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InterpreterStatus variable + +> Warning: This API is now obsolete. +> +> Use `ActorStatus` instead. +> + +**Signature:** + +```typescript +InterpreterStatus: typeof ActorStatus +``` diff --git a/api/xstate/xstate.invokeconfig.md b/api/xstate/xstate.invokeconfig.md new file mode 100644 index 000000000..ebb9e12ee --- /dev/null +++ b/api/xstate/xstate.invokeconfig.md @@ -0,0 +1,29 @@ +--- +title: "InvokeConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeConfig type + +**Signature:** + +```typescript +export type InvokeConfig = IsLiteralString extends true ? DistributeActors : { + id?: string; + systemId?: string; + src: AnyActorLogic | string; + input?: Mapper | NonReducibleUnknown; + onDone?: string | SingleOrArray, // TODO: consider replacing with `unknown` + TEvent, TActor, TAction, TGuard, TDelay>>; + onError?: string | SingleOrArray>; + onSnapshot?: string | SingleOrArray>; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [IsLiteralString](./xstate.isliteralstring.md)<>, [AnyActorLogic](./xstate.anyactorlogic.md)<>, [Mapper](./xstate.mapper.md)<>, [NonReducibleUnknown](./xstate.nonreducibleunknown.md)<>, [SingleOrArray](./xstate.singleorarray.md)<>, [TransitionConfigOrTarget](./xstate.transitionconfigortarget.md)<>, [DoneActorEvent](./xstate.doneactorevent.md)<>, [ErrorActorEvent](./xstate.erroractorevent.md)<>, [SnapshotEvent](./xstate.snapshotevent.md) + diff --git a/api/xstate/xstate.invokedefinition.id.md b/api/xstate/xstate.invokedefinition.id.md new file mode 100644 index 000000000..b677d75d7 --- /dev/null +++ b/api/xstate/xstate.invokedefinition.id.md @@ -0,0 +1,18 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition.id property + +**Signature:** + +```typescript +id: string; +``` diff --git a/api/xstate/xstate.invokedefinition.input.md b/api/xstate/xstate.invokedefinition.input.md new file mode 100644 index 000000000..e0f2499da --- /dev/null +++ b/api/xstate/xstate.invokedefinition.input.md @@ -0,0 +1,18 @@ +--- +title: "input" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition.input property + +**Signature:** + +```typescript +input?: Mapper | NonReducibleUnknown; +``` diff --git a/api/xstate/xstate.invokedefinition.md b/api/xstate/xstate.invokedefinition.md new file mode 100644 index 000000000..0a59b423a --- /dev/null +++ b/api/xstate/xstate.invokedefinition.md @@ -0,0 +1,32 @@ +--- +title: "InvokeDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition interface + +**Signature:** + +```typescript +export interface InvokeDefinition +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [id](./xstate.invokedefinition.id.md) | | string | | +| [input?](./xstate.invokedefinition.input.md) | | [Mapper](./xstate.mapper.md)<><TContext, TEvent, [NonReducibleUnknown](./xstate.nonreducibleunknown.md)<>, TEvent> \| [NonReducibleUnknown](./xstate.nonreducibleunknown.md) | _(Optional)_ | +| [onDone?](./xstate.invokedefinition.ondone.md) | | string \| [SingleOrArray](./xstate.singleorarray.md)<><[TransitionConfig](./xstate.transitionconfig.md)<><TContext, [DoneActorEvent](./xstate.doneactorevent.md)<><unknown>, TEvent, TActor, TAction, TGuard, TDelay>> | _(Optional)_ The transition to take upon the invoked child machine reaching its final top-level state. | +| [onError?](./xstate.invokedefinition.onerror.md) | | string \| [SingleOrArray](./xstate.singleorarray.md)<><[TransitionConfig](./xstate.transitionconfig.md)<><TContext, [ErrorActorEvent](./xstate.erroractorevent.md)<>, TEvent, TActor, TAction, TGuard, TDelay>> | _(Optional)_ The transition to take upon the invoked child machine sending an error event. | +| [onSnapshot?](./xstate.invokedefinition.onsnapshot.md) | | string \| [SingleOrArray](./xstate.singleorarray.md)<><[TransitionConfig](./xstate.transitionconfig.md)<><TContext, [SnapshotEvent](./xstate.snapshotevent.md)<>, TEvent, TActor, TAction, TGuard, TDelay>> | _(Optional)_ | +| [src](./xstate.invokedefinition.src.md) | | string | The source of the actor logic to be invoked | +| [systemId](./xstate.invokedefinition.systemid.md) | | string \| undefined | | +| [toJSON](./xstate.invokedefinition.tojson.md) | | () => Omit<[InvokeDefinition](./xstate.invokedefinition.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay>, 'onDone' \| 'onError' \| 'toJSON'> | | + diff --git a/api/xstate/xstate.invokedefinition.ondone.md b/api/xstate/xstate.invokedefinition.ondone.md new file mode 100644 index 000000000..e5c4bcde0 --- /dev/null +++ b/api/xstate/xstate.invokedefinition.ondone.md @@ -0,0 +1,20 @@ +--- +title: "onDone" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition.onDone property + +The transition to take upon the invoked child machine reaching its final top-level state. + +**Signature:** + +```typescript +onDone?: string | SingleOrArray, TEvent, TActor, TAction, TGuard, TDelay>>; +``` diff --git a/api/xstate/xstate.invokedefinition.onerror.md b/api/xstate/xstate.invokedefinition.onerror.md new file mode 100644 index 000000000..91708b3be --- /dev/null +++ b/api/xstate/xstate.invokedefinition.onerror.md @@ -0,0 +1,20 @@ +--- +title: "onError" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition.onError property + +The transition to take upon the invoked child machine sending an error event. + +**Signature:** + +```typescript +onError?: string | SingleOrArray>; +``` diff --git a/api/xstate/xstate.invokedefinition.onsnapshot.md b/api/xstate/xstate.invokedefinition.onsnapshot.md new file mode 100644 index 000000000..8a6fa3d57 --- /dev/null +++ b/api/xstate/xstate.invokedefinition.onsnapshot.md @@ -0,0 +1,18 @@ +--- +title: "onSnapshot" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition.onSnapshot property + +**Signature:** + +```typescript +onSnapshot?: string | SingleOrArray>; +``` diff --git a/api/xstate/xstate.invokedefinition.src.md b/api/xstate/xstate.invokedefinition.src.md new file mode 100644 index 000000000..06e614caf --- /dev/null +++ b/api/xstate/xstate.invokedefinition.src.md @@ -0,0 +1,20 @@ +--- +title: "src" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition.src property + +The source of the actor logic to be invoked + +**Signature:** + +```typescript +src: string; +``` diff --git a/api/xstate/xstate.invokedefinition.systemid.md b/api/xstate/xstate.invokedefinition.systemid.md new file mode 100644 index 000000000..821a0aae5 --- /dev/null +++ b/api/xstate/xstate.invokedefinition.systemid.md @@ -0,0 +1,18 @@ +--- +title: "systemId" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition.systemId property + +**Signature:** + +```typescript +systemId: string | undefined; +``` diff --git a/api/xstate/xstate.invokedefinition.tojson.md b/api/xstate/xstate.invokedefinition.tojson.md new file mode 100644 index 000000000..2177326a4 --- /dev/null +++ b/api/xstate/xstate.invokedefinition.tojson.md @@ -0,0 +1,18 @@ +--- +title: "toJSON" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## InvokeDefinition.toJSON property + +**Signature:** + +```typescript +toJSON: () => Omit, 'onDone' | 'onError' | 'toJSON'>; +``` diff --git a/api/xstate/xstate.isany.md b/api/xstate/xstate.isany.md new file mode 100644 index 000000000..4dd361a53 --- /dev/null +++ b/api/xstate/xstate.isany.md @@ -0,0 +1,20 @@ +--- +title: "IsAny" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## IsAny type + +**Signature:** + +```typescript +export type IsAny = Equals; +``` +**References:** [Equals](./xstate.equals.md) + diff --git a/api/xstate/xstate.isliteralstring.md b/api/xstate/xstate.isliteralstring.md new file mode 100644 index 000000000..844a80ccc --- /dev/null +++ b/api/xstate/xstate.isliteralstring.md @@ -0,0 +1,18 @@ +--- +title: "IsLiteralString" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## IsLiteralString type + +**Signature:** + +```typescript +export type IsLiteralString = string extends T ? false : true; +``` diff --git a/api/xstate/xstate.isnever.md b/api/xstate/xstate.isnever.md new file mode 100644 index 000000000..f0d5cacf6 --- /dev/null +++ b/api/xstate/xstate.isnever.md @@ -0,0 +1,18 @@ +--- +title: "IsNever" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## IsNever type + +**Signature:** + +```typescript +export type IsNever = [T] extends [never] ? true : false; +``` diff --git a/api/xstate/xstate.lazy.md b/api/xstate/xstate.lazy.md new file mode 100644 index 000000000..c5f61b44e --- /dev/null +++ b/api/xstate/xstate.lazy.md @@ -0,0 +1,18 @@ +--- +title: "Lazy" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Lazy type + +**Signature:** + +```typescript +export type Lazy = () => T; +``` diff --git a/api/xstate/xstate.log.md b/api/xstate/xstate.log.md new file mode 100644 index 000000000..dc6a6ed81 --- /dev/null +++ b/api/xstate/xstate.log.md @@ -0,0 +1,30 @@ +--- +title: "log" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## log() function + +**Signature:** + +```typescript +export declare function log(value?: ResolvableLogValue, label?: string): LogAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| value | ResolvableLogValue<TContext, TExpressionEvent, TExpressionAction, TEvent> | _(Optional)_ | +| label | string | _(Optional)_ The label to give to the logged expression. | + +**Returns:** + +[LogAction](./xstate.logaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent> + diff --git a/api/xstate/xstate.logaction.md b/api/xstate/xstate.logaction.md new file mode 100644 index 000000000..6a0251033 --- /dev/null +++ b/api/xstate/xstate.logaction.md @@ -0,0 +1,18 @@ +--- +title: "LogAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## LogAction interface + +**Signature:** + +```typescript +export interface LogAction +``` diff --git a/api/xstate/xstate.logexpr.md b/api/xstate/xstate.logexpr.md new file mode 100644 index 000000000..235517e22 --- /dev/null +++ b/api/xstate/xstate.logexpr.md @@ -0,0 +1,20 @@ +--- +title: "LogExpr" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## LogExpr type + +**Signature:** + +```typescript +export type LogExpr = (args: ActionArgs) => unknown; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ActionArgs](./xstate.actionargs.md) + diff --git a/api/xstate/xstate.lowinfer.md b/api/xstate/xstate.lowinfer.md new file mode 100644 index 000000000..8cfc81531 --- /dev/null +++ b/api/xstate/xstate.lowinfer.md @@ -0,0 +1,18 @@ +--- +title: "LowInfer" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## LowInfer type + +**Signature:** + +```typescript +export type LowInfer = T & {}; +``` diff --git a/api/xstate/xstate.machineconfig.md b/api/xstate/xstate.machineconfig.md new file mode 100644 index 000000000..9edddcfee --- /dev/null +++ b/api/xstate/xstate.machineconfig.md @@ -0,0 +1,28 @@ +--- +title: "MachineConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineConfig type + +**Signature:** + +```typescript +export type MachineConfig = (Omit, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer, NoInfer>, 'output'> & { + version?: string; + types?: MachineTypes; + output?: Mapper | TOutput; +}) & (MachineContext extends TContext ? { + context?: InitialContext, TActor, TInput>; +} : { + context: InitialContext, TActor, TInput>; +}); +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [TypegenDisabled](./xstate.typegendisabled.md)<>, [StateNodeConfig](./xstate.statenodeconfig.md)<>, [NoInfer](./xstate.noinfer.md)<>, [MachineTypes](./xstate.machinetypes.md)<>, [Mapper](./xstate.mapper.md)<>, [DoneStateEvent](./xstate.donestateevent.md)<>, [LowInfer](./xstate.lowinfer.md) + diff --git a/api/xstate/xstate.machinecontext.md b/api/xstate/xstate.machinecontext.md new file mode 100644 index 000000000..fbcbda2a8 --- /dev/null +++ b/api/xstate/xstate.machinecontext.md @@ -0,0 +1,18 @@ +--- +title: "MachineContext" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineContext type + +**Signature:** + +```typescript +export type MachineContext = Record; +``` diff --git a/api/xstate/xstate.machineimplementations.md b/api/xstate/xstate.machineimplementations.md new file mode 100644 index 000000000..71dfb7374 --- /dev/null +++ b/api/xstate/xstate.machineimplementations.md @@ -0,0 +1,20 @@ +--- +title: "MachineImplementations" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineImplementations type + +**Signature:** + +```typescript +export type MachineImplementations = InternalMachineImplementations>; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [TypegenConstraint](./xstate.typegenconstraint.md)<>, [TypegenDisabled](./xstate.typegendisabled.md)<>, [InternalMachineImplementations](./xstate.internalmachineimplementations.md)<>, [ResolveTypegenMeta](./xstate.resolvetypegenmeta.md) + diff --git a/api/xstate/xstate.machineimplementationsfrom.md b/api/xstate/xstate.machineimplementationsfrom.md new file mode 100644 index 000000000..1a44bcaf2 --- /dev/null +++ b/api/xstate/xstate.machineimplementationsfrom.md @@ -0,0 +1,20 @@ +--- +title: "MachineImplementationsFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineImplementationsFrom type + +**Signature:** + +```typescript +export type MachineImplementationsFrom AnyStateMachine), TRequireMissingImplementations extends boolean = false> = ReturnTypeOrValue extends StateMachine ? InternalMachineImplementations : never; +``` +**References:** [AnyStateMachine](./xstate.anystatemachine.md)<>, [StateMachine](./xstate.statemachine.md)<>, [InternalMachineImplementations](./xstate.internalmachineimplementations.md) + diff --git a/api/xstate/xstate.machineimplementationssimplified.actions.md b/api/xstate/xstate.machineimplementationssimplified.actions.md new file mode 100644 index 000000000..dfc55ddbc --- /dev/null +++ b/api/xstate/xstate.machineimplementationssimplified.actions.md @@ -0,0 +1,18 @@ +--- +title: "actions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineImplementationsSimplified.actions property + +**Signature:** + +```typescript +actions: ActionFunctionMap; +``` diff --git a/api/xstate/xstate.machineimplementationssimplified.actors.md b/api/xstate/xstate.machineimplementationssimplified.actors.md new file mode 100644 index 000000000..07a0d095e --- /dev/null +++ b/api/xstate/xstate.machineimplementationssimplified.actors.md @@ -0,0 +1,21 @@ +--- +title: "actors" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineImplementationsSimplified.actors property + +**Signature:** + +```typescript +actors: Record | NonReducibleUnknown; + }>; +``` diff --git a/api/xstate/xstate.machineimplementationssimplified.delays.md b/api/xstate/xstate.machineimplementationssimplified.delays.md new file mode 100644 index 000000000..0af52e41a --- /dev/null +++ b/api/xstate/xstate.machineimplementationssimplified.delays.md @@ -0,0 +1,18 @@ +--- +title: "delays" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineImplementationsSimplified.delays property + +**Signature:** + +```typescript +delays: DelayFunctionMap; +``` diff --git a/api/xstate/xstate.machineimplementationssimplified.guards.md b/api/xstate/xstate.machineimplementationssimplified.guards.md new file mode 100644 index 000000000..f5dc86e3f --- /dev/null +++ b/api/xstate/xstate.machineimplementationssimplified.guards.md @@ -0,0 +1,18 @@ +--- +title: "guards" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineImplementationsSimplified.guards property + +**Signature:** + +```typescript +guards: GuardMap; +``` diff --git a/api/xstate/xstate.machineimplementationssimplified.md b/api/xstate/xstate.machineimplementationssimplified.md new file mode 100644 index 000000000..da3a1feda --- /dev/null +++ b/api/xstate/xstate.machineimplementationssimplified.md @@ -0,0 +1,28 @@ +--- +title: "MachineImplementationsSimplified" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineImplementationsSimplified interface + +**Signature:** + +```typescript +export interface MachineImplementationsSimplified +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actions](./xstate.machineimplementationssimplified.actions.md) | | [ActionFunctionMap](./xstate.actionfunctionmap.md)<><TContext, TEvent, TActor, TAction> | | +| [actors](./xstate.machineimplementationssimplified.actors.md) | | Record<string, [AnyActorLogic](./xstate.anyactorlogic.md) \| { src: [AnyActorLogic](./xstate.anyactorlogic.md)<>; input: [Mapper](./xstate.mapper.md)<><TContext, TEvent, unknown, TEvent> \| [NonReducibleUnknown](./xstate.nonreducibleunknown.md)<>; }> | | +| [delays](./xstate.machineimplementationssimplified.delays.md) | | [DelayFunctionMap](./xstate.delayfunctionmap.md)<><TContext, TEvent, TAction> | | +| [guards](./xstate.machineimplementationssimplified.guards.md) | | GuardMap<TContext, TEvent, TGuard> | | + diff --git a/api/xstate/xstate.machinesnapshot.md b/api/xstate/xstate.machinesnapshot.md new file mode 100644 index 000000000..9a6479b04 --- /dev/null +++ b/api/xstate/xstate.machinesnapshot.md @@ -0,0 +1,36 @@ +--- +title: "MachineSnapshot" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineSnapshot type + +**Signature:** + +```typescript +export type MachineSnapshot = (State & { + status: 'active'; + output: undefined; + error: undefined; +}) | (State & { + status: 'done'; + output: TOutput; + error: undefined; +}) | (State & { + status: 'error'; + output: undefined; + error: unknown; +}) | (State & { + status: 'stopped'; + output: undefined; + error: undefined; +}); +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [TypegenDisabled](./xstate.typegendisabled.md)<>, [State](./xstate.state.md) + diff --git a/api/xstate/xstate.machinetypes.actions.md b/api/xstate/xstate.machinetypes.actions.md new file mode 100644 index 000000000..dab0f38de --- /dev/null +++ b/api/xstate/xstate.machinetypes.actions.md @@ -0,0 +1,18 @@ +--- +title: "actions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.actions property + +**Signature:** + +```typescript +actions?: TAction; +``` diff --git a/api/xstate/xstate.machinetypes.actors.md b/api/xstate/xstate.machinetypes.actors.md new file mode 100644 index 000000000..f8a2216df --- /dev/null +++ b/api/xstate/xstate.machinetypes.actors.md @@ -0,0 +1,18 @@ +--- +title: "actors" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.actors property + +**Signature:** + +```typescript +actors?: TActor; +``` diff --git a/api/xstate/xstate.machinetypes.context.md b/api/xstate/xstate.machinetypes.context.md new file mode 100644 index 000000000..52c904786 --- /dev/null +++ b/api/xstate/xstate.machinetypes.context.md @@ -0,0 +1,18 @@ +--- +title: "context" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.context property + +**Signature:** + +```typescript +context?: TContext; +``` diff --git a/api/xstate/xstate.machinetypes.delays.md b/api/xstate/xstate.machinetypes.delays.md new file mode 100644 index 000000000..fb4e4ca91 --- /dev/null +++ b/api/xstate/xstate.machinetypes.delays.md @@ -0,0 +1,18 @@ +--- +title: "delays" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.delays property + +**Signature:** + +```typescript +delays?: TDelay; +``` diff --git a/api/xstate/xstate.machinetypes.events.md b/api/xstate/xstate.machinetypes.events.md new file mode 100644 index 000000000..886d90587 --- /dev/null +++ b/api/xstate/xstate.machinetypes.events.md @@ -0,0 +1,18 @@ +--- +title: "events" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.events property + +**Signature:** + +```typescript +events?: TEvent; +``` diff --git a/api/xstate/xstate.machinetypes.guards.md b/api/xstate/xstate.machinetypes.guards.md new file mode 100644 index 000000000..a9dcee88a --- /dev/null +++ b/api/xstate/xstate.machinetypes.guards.md @@ -0,0 +1,18 @@ +--- +title: "guards" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.guards property + +**Signature:** + +```typescript +guards?: TGuard; +``` diff --git a/api/xstate/xstate.machinetypes.input.md b/api/xstate/xstate.machinetypes.input.md new file mode 100644 index 000000000..9fc9c3e02 --- /dev/null +++ b/api/xstate/xstate.machinetypes.input.md @@ -0,0 +1,18 @@ +--- +title: "input" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.input property + +**Signature:** + +```typescript +input?: TInput; +``` diff --git a/api/xstate/xstate.machinetypes.md b/api/xstate/xstate.machinetypes.md new file mode 100644 index 000000000..ce2b305cb --- /dev/null +++ b/api/xstate/xstate.machinetypes.md @@ -0,0 +1,34 @@ +--- +title: "MachineTypes" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes interface + +**Signature:** + +```typescript +export interface MachineTypes +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actions?](./xstate.machinetypes.actions.md) | | TAction | _(Optional)_ | +| [actors?](./xstate.machinetypes.actors.md) | | TActor | _(Optional)_ | +| [context?](./xstate.machinetypes.context.md) | | TContext | _(Optional)_ | +| [delays?](./xstate.machinetypes.delays.md) | | TDelay | _(Optional)_ | +| [events?](./xstate.machinetypes.events.md) | | TEvent | _(Optional)_ | +| [guards?](./xstate.machinetypes.guards.md) | | TGuard | _(Optional)_ | +| [input?](./xstate.machinetypes.input.md) | | TInput | _(Optional)_ | +| [output?](./xstate.machinetypes.output.md) | | TOutput | _(Optional)_ | +| [tags?](./xstate.machinetypes.tags.md) | | TTag | _(Optional)_ | +| [typegen?](./xstate.machinetypes.typegen.md) | | TTypesMeta | _(Optional)_ | + diff --git a/api/xstate/xstate.machinetypes.output.md b/api/xstate/xstate.machinetypes.output.md new file mode 100644 index 000000000..4c93d64bf --- /dev/null +++ b/api/xstate/xstate.machinetypes.output.md @@ -0,0 +1,18 @@ +--- +title: "output" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.output property + +**Signature:** + +```typescript +output?: TOutput; +``` diff --git a/api/xstate/xstate.machinetypes.tags.md b/api/xstate/xstate.machinetypes.tags.md new file mode 100644 index 000000000..24d150b17 --- /dev/null +++ b/api/xstate/xstate.machinetypes.tags.md @@ -0,0 +1,18 @@ +--- +title: "tags" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.tags property + +**Signature:** + +```typescript +tags?: TTag; +``` diff --git a/api/xstate/xstate.machinetypes.typegen.md b/api/xstate/xstate.machinetypes.typegen.md new file mode 100644 index 000000000..336a42e75 --- /dev/null +++ b/api/xstate/xstate.machinetypes.typegen.md @@ -0,0 +1,18 @@ +--- +title: "typegen" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MachineTypes.typegen property + +**Signature:** + +```typescript +typegen?: TTypesMeta; +``` diff --git a/api/xstate/xstate.mapper.md b/api/xstate/xstate.mapper.md new file mode 100644 index 000000000..b0b8c8b43 --- /dev/null +++ b/api/xstate/xstate.mapper.md @@ -0,0 +1,24 @@ +--- +title: "Mapper" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Mapper type + +**Signature:** + +```typescript +export type Mapper = (args: { + context: TContext; + event: TExpressionEvent; + self: ActorRef>; +}) => TResult; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ActorRef](./xstate.actorref.md)<>, [MachineSnapshot](./xstate.machinesnapshot.md)<>, [ProvidedActor](./xstate.providedactor.md) + diff --git a/api/xstate/xstate.mapstate.md b/api/xstate/xstate.mapstate.md new file mode 100644 index 000000000..bb0a0f3e3 --- /dev/null +++ b/api/xstate/xstate.mapstate.md @@ -0,0 +1,32 @@ +--- +title: "mapState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## mapState() function + +**Signature:** + +```typescript +export declare function mapState(stateMap: { + [stateId: string]: any; +}, stateId: string): any; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stateMap | { \[stateId: string\]: any; } | | +| stateId | string | | + +**Returns:** + +any + diff --git a/api/xstate/xstate.markallimplementationsasprovided.___xstate_typegen_.md b/api/xstate/xstate.markallimplementationsasprovided.___xstate_typegen_.md new file mode 100644 index 000000000..dcf4e3c0d --- /dev/null +++ b/api/xstate/xstate.markallimplementationsasprovided.___xstate_typegen_.md @@ -0,0 +1,18 @@ +--- +title: "\"@@xstate/typegen\"" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MarkAllImplementationsAsProvided."@@xstate/typegen" property + +**Signature:** + +```typescript +'@@xstate/typegen': Prop; +``` diff --git a/api/xstate/xstate.markallimplementationsasprovided.md b/api/xstate/xstate.markallimplementationsasprovided.md new file mode 100644 index 000000000..a9112ab51 --- /dev/null +++ b/api/xstate/xstate.markallimplementationsasprovided.md @@ -0,0 +1,26 @@ +--- +title: "MarkAllImplementationsAsProvided" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MarkAllImplementationsAsProvided interface + +**Signature:** + +```typescript +export interface MarkAllImplementationsAsProvided +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| ["@@xstate/typegen"](./xstate.markallimplementationsasprovided.___xstate_typegen_.md) | | [Prop](./xstate.prop.md)<><TResolvedTypesMeta, '@@xstate/typegen'> | | +| [resolved](./xstate.markallimplementationsasprovided.resolved.md) | | [Prop](./xstate.prop.md)<><TResolvedTypesMeta, 'resolved'> & AllImplementationsProvided | | + diff --git a/api/xstate/xstate.markallimplementationsasprovided.resolved.md b/api/xstate/xstate.markallimplementationsasprovided.resolved.md new file mode 100644 index 000000000..159f0638e --- /dev/null +++ b/api/xstate/xstate.markallimplementationsasprovided.resolved.md @@ -0,0 +1,18 @@ +--- +title: "resolved" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MarkAllImplementationsAsProvided.resolved property + +**Signature:** + +```typescript +resolved: Prop & AllImplementationsProvided; +``` diff --git a/api/xstate/xstate.matchesstate.md b/api/xstate/xstate.matchesstate.md new file mode 100644 index 000000000..f5a0660e1 --- /dev/null +++ b/api/xstate/xstate.matchesstate.md @@ -0,0 +1,30 @@ +--- +title: "matchesState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## matchesState() function + +**Signature:** + +```typescript +export declare function matchesState(parentStateId: StateValue, childStateId: StateValue): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parentStateId | [StateValue](./xstate.statevalue.md) | | +| childStateId | [StateValue](./xstate.statevalue.md) | | + +**Returns:** + +boolean + diff --git a/api/xstate/xstate.maybelazy.md b/api/xstate/xstate.maybelazy.md new file mode 100644 index 000000000..8c87a368f --- /dev/null +++ b/api/xstate/xstate.maybelazy.md @@ -0,0 +1,20 @@ +--- +title: "MaybeLazy" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MaybeLazy type + +**Signature:** + +```typescript +export type MaybeLazy = T | Lazy; +``` +**References:** [Lazy](./xstate.lazy.md) + diff --git a/api/xstate/xstate.merge.md b/api/xstate/xstate.merge.md new file mode 100644 index 000000000..78fc1ee53 --- /dev/null +++ b/api/xstate/xstate.merge.md @@ -0,0 +1,18 @@ +--- +title: "Merge" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Merge type + +**Signature:** + +```typescript +export type Merge = Omit & N; +``` diff --git a/api/xstate/xstate.metaobject.md b/api/xstate/xstate.metaobject.md new file mode 100644 index 000000000..7821a0415 --- /dev/null +++ b/api/xstate/xstate.metaobject.md @@ -0,0 +1,18 @@ +--- +title: "MetaObject" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MetaObject type + +**Signature:** + +```typescript +export type MetaObject = Record; +``` diff --git a/api/xstate/xstate.missingimplementationserror.md b/api/xstate/xstate.missingimplementationserror.md new file mode 100644 index 000000000..3ab36cc3a --- /dev/null +++ b/api/xstate/xstate.missingimplementationserror.md @@ -0,0 +1,25 @@ +--- +title: "MissingImplementationsError" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## MissingImplementationsError type + +**Signature:** + +```typescript +export type MissingImplementationsError, 'missingImplementations'>> = Compute<[ + 'Some implementations missing', + Values<{ + [K in keyof TMissingImplementations]: TMissingImplementations[K]; + }> +]>; +``` +**References:** [Prop](./xstate.prop.md)<>, [Compute](./xstate.compute.md)<>, [Values](./xstate.values.md) + diff --git a/api/xstate/xstate.noinfer.md b/api/xstate/xstate.noinfer.md new file mode 100644 index 000000000..0bf0c8259 --- /dev/null +++ b/api/xstate/xstate.noinfer.md @@ -0,0 +1,18 @@ +--- +title: "NoInfer" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## NoInfer type + +**Signature:** + +```typescript +export type NoInfer = [T][T extends any ? 0 : any]; +``` diff --git a/api/xstate/xstate.nonreducibleunknown.md b/api/xstate/xstate.nonreducibleunknown.md new file mode 100644 index 000000000..a74bb5dee --- /dev/null +++ b/api/xstate/xstate.nonreducibleunknown.md @@ -0,0 +1,26 @@ +--- +title: "NonReducibleUnknown" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## NonReducibleUnknown type + +`T | unknown` reduces to `unknown` and that can be problematic when it comes to contextual typing. It especially is a problem when the union has a function member, like here: + +```ts +declare function test(cbOrVal: ((arg: number) => unknown) | unknown): void; +test((arg) => {}) // oops, implicit any +``` +This type can be used to avoid this problem. This union represents the same value space as `unknown`<>. + +**Signature:** + +```typescript +export type NonReducibleUnknown = {} | null | undefined; +``` diff --git a/api/xstate/xstate.norequiredparams.md b/api/xstate/xstate.norequiredparams.md new file mode 100644 index 000000000..9d10bd6ef --- /dev/null +++ b/api/xstate/xstate.norequiredparams.md @@ -0,0 +1,22 @@ +--- +title: "NoRequiredParams" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## NoRequiredParams type + +**Signature:** + +```typescript +export type NoRequiredParams = T extends any ? { + type: T['type']; +} extends T ? T['type'] : never : never; +``` +**References:** [ParameterizedObject](./xstate.parameterizedobject.md) + diff --git a/api/xstate/xstate.not.md b/api/xstate/xstate.not.md new file mode 100644 index 000000000..4420547ee --- /dev/null +++ b/api/xstate/xstate.not.md @@ -0,0 +1,29 @@ +--- +title: "not" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## not() function + +**Signature:** + +```typescript +export declare function not(guard: Guard>): GuardPredicate; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| guard | Guard<TContext, TExpressionEvent, TExpressionGuard, [NoInfer](./xstate.noinfer.md)<><TGuard>> | | + +**Returns:** + +GuardPredicate<TContext, TExpressionEvent, TExpressionGuard, TGuard> + diff --git a/api/xstate/xstate.observableactorlogic.md b/api/xstate/xstate.observableactorlogic.md new file mode 100644 index 000000000..15f7e02a0 --- /dev/null +++ b/api/xstate/xstate.observableactorlogic.md @@ -0,0 +1,23 @@ +--- +title: "ObservableActorLogic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ObservableActorLogic type + +**Signature:** + +```typescript +export type ObservableActorLogic = ActorLogic, { + type: string; + [k: string]: unknown; +}, TInput, ObservablePersistedState, AnyActorSystem>; +``` +**References:** [ActorLogic](./xstate.actorlogic.md)<>, [AnyActorSystem](./xstate.anyactorsystem.md) + diff --git a/api/xstate/xstate.observer.md b/api/xstate/xstate.observer.md new file mode 100644 index 000000000..29c8e190e --- /dev/null +++ b/api/xstate/xstate.observer.md @@ -0,0 +1,22 @@ +--- +title: "Observer" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Observer type + +**Signature:** + +```typescript +export type Observer = { + next?: (value: T) => void; + error?: (err: unknown) => void; + complete?: () => void; +}; +``` diff --git a/api/xstate/xstate.or.md b/api/xstate/xstate.or.md new file mode 100644 index 000000000..ff0feff60 --- /dev/null +++ b/api/xstate/xstate.or.md @@ -0,0 +1,29 @@ +--- +title: "or" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## or() function + +**Signature:** + +```typescript +export declare function or(guards: ReadonlyArray>>): GuardPredicate; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| guards | ReadonlyArray<Guard<TContext, TExpressionEvent, TExpressionGuard, [NoInfer](./xstate.noinfer.md)<><TGuard>>> | | + +**Returns:** + +GuardPredicate<TContext, TExpressionEvent, TExpressionGuard, TGuard> + diff --git a/api/xstate/xstate.outputfrom.md b/api/xstate/xstate.outputfrom.md new file mode 100644 index 000000000..f8ebd1e08 --- /dev/null +++ b/api/xstate/xstate.outputfrom.md @@ -0,0 +1,22 @@ +--- +title: "OutputFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## OutputFrom type + +**Signature:** + +```typescript +export type OutputFrom = T extends ActorLogic ? (TSnapshot & { + status: 'done'; +})['output'] : never; +``` +**References:** [AnyActorLogic](./xstate.anyactorlogic.md)<>, [ActorLogic](./xstate.actorlogic.md) + diff --git a/api/xstate/xstate.parameterizedobject.md b/api/xstate/xstate.parameterizedobject.md new file mode 100644 index 000000000..1dd60de89 --- /dev/null +++ b/api/xstate/xstate.parameterizedobject.md @@ -0,0 +1,26 @@ +--- +title: "ParameterizedObject" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ParameterizedObject interface + +**Signature:** + +```typescript +export interface ParameterizedObject +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [params?](./xstate.parameterizedobject.params.md) | | Record<string, unknown> | _(Optional)_ | +| [type](./xstate.parameterizedobject.type.md) | | string | | + diff --git a/api/xstate/xstate.parameterizedobject.params.md b/api/xstate/xstate.parameterizedobject.params.md new file mode 100644 index 000000000..9bdcd3714 --- /dev/null +++ b/api/xstate/xstate.parameterizedobject.params.md @@ -0,0 +1,18 @@ +--- +title: "params" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ParameterizedObject.params property + +**Signature:** + +```typescript +params?: Record; +``` diff --git a/api/xstate/xstate.parameterizedobject.type.md b/api/xstate/xstate.parameterizedobject.type.md new file mode 100644 index 000000000..3e815dc2c --- /dev/null +++ b/api/xstate/xstate.parameterizedobject.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ParameterizedObject.type property + +**Signature:** + +```typescript +type: string; +``` diff --git a/api/xstate/xstate.partialassigner.md b/api/xstate/xstate.partialassigner.md new file mode 100644 index 000000000..23c30ba4a --- /dev/null +++ b/api/xstate/xstate.partialassigner.md @@ -0,0 +1,20 @@ +--- +title: "PartialAssigner" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PartialAssigner type + +**Signature:** + +```typescript +export type PartialAssigner = (args: AssignArgs) => TContext[TKey]; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [AssignArgs](./xstate.assignargs.md) + diff --git a/api/xstate/xstate.pathtostatevalue.md b/api/xstate/xstate.pathtostatevalue.md new file mode 100644 index 000000000..d6661156c --- /dev/null +++ b/api/xstate/xstate.pathtostatevalue.md @@ -0,0 +1,29 @@ +--- +title: "pathToStateValue" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## pathToStateValue() function + +**Signature:** + +```typescript +export declare function pathToStateValue(statePath: string[]): StateValue; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| statePath | string\[\] | | + +**Returns:** + +[StateValue](./xstate.statevalue.md) + diff --git a/api/xstate/xstate.persistedmachinestate.md b/api/xstate/xstate.persistedmachinestate.md new file mode 100644 index 000000000..a6ff4032a --- /dev/null +++ b/api/xstate/xstate.persistedmachinestate.md @@ -0,0 +1,27 @@ +--- +title: "PersistedMachineState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PersistedMachineState type + +**Signature:** + +```typescript +export type PersistedMachineState = HomomorphicPick, 'value' | 'output' | 'error' | 'context' | 'status' | 'historyValue'> & { + children: { + [K in keyof MachineSnapshot['children']]: { + state: any; + src?: string; + }; + }; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [TypegenDisabled](./xstate.typegendisabled.md)<>, [HomomorphicPick](./xstate.homomorphicpick.md)<>, [MachineSnapshot](./xstate.machinesnapshot.md) + diff --git a/api/xstate/xstate.persistedstatefrom.md b/api/xstate/xstate.persistedstatefrom.md new file mode 100644 index 000000000..0a38c9efa --- /dev/null +++ b/api/xstate/xstate.persistedstatefrom.md @@ -0,0 +1,20 @@ +--- +title: "PersistedStateFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PersistedStateFrom type + +**Signature:** + +```typescript +export type PersistedStateFrom> = TLogic extends ActorLogic ? TPersisted : never; +``` +**References:** [ActorLogic](./xstate.actorlogic.md) + diff --git a/api/xstate/xstate.promiseactorlogic.md b/api/xstate/xstate.promiseactorlogic.md new file mode 100644 index 000000000..399ab3b1c --- /dev/null +++ b/api/xstate/xstate.promiseactorlogic.md @@ -0,0 +1,25 @@ +--- +title: "PromiseActorLogic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PromiseActorLogic type + +**Signature:** + +```typescript +export type PromiseActorLogic = ActorLogic, { + type: string; + [k: string]: unknown; +}, TInput, // input +PromiseSnapshot, // persisted state +ActorSystem>; +``` +**References:** [ActorLogic](./xstate.actorlogic.md)<>, [ActorSystem](./xstate.actorsystem.md) + diff --git a/api/xstate/xstate.prop.md b/api/xstate/xstate.prop.md new file mode 100644 index 000000000..06de382ed --- /dev/null +++ b/api/xstate/xstate.prop.md @@ -0,0 +1,18 @@ +--- +title: "Prop" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Prop type + +**Signature:** + +```typescript +export type Prop = K extends keyof T ? T[K] : never; +``` diff --git a/api/xstate/xstate.propertyassigner.md b/api/xstate/xstate.propertyassigner.md new file mode 100644 index 000000000..226bbeec3 --- /dev/null +++ b/api/xstate/xstate.propertyassigner.md @@ -0,0 +1,22 @@ +--- +title: "PropertyAssigner" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PropertyAssigner type + +**Signature:** + +```typescript +export type PropertyAssigner = { + [K in keyof TContext]?: PartialAssigner | TContext[K]; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [PartialAssigner](./xstate.partialassigner.md) + diff --git a/api/xstate/xstate.providedactor.id.md b/api/xstate/xstate.providedactor.id.md new file mode 100644 index 000000000..5b8ccbe44 --- /dev/null +++ b/api/xstate/xstate.providedactor.id.md @@ -0,0 +1,18 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ProvidedActor.id property + +**Signature:** + +```typescript +id?: string; +``` diff --git a/api/xstate/xstate.providedactor.logic.md b/api/xstate/xstate.providedactor.logic.md new file mode 100644 index 000000000..5f179ea67 --- /dev/null +++ b/api/xstate/xstate.providedactor.logic.md @@ -0,0 +1,18 @@ +--- +title: "logic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ProvidedActor.logic property + +**Signature:** + +```typescript +logic: AnyActorLogic; +``` diff --git a/api/xstate/xstate.providedactor.md b/api/xstate/xstate.providedactor.md new file mode 100644 index 000000000..16e58c85c --- /dev/null +++ b/api/xstate/xstate.providedactor.md @@ -0,0 +1,27 @@ +--- +title: "ProvidedActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ProvidedActor interface + +**Signature:** + +```typescript +export interface ProvidedActor +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [id?](./xstate.providedactor.id.md) | | string | _(Optional)_ | +| [logic](./xstate.providedactor.logic.md) | | [AnyActorLogic](./xstate.anyactorlogic.md) | | +| [src](./xstate.providedactor.src.md) | | string | | + diff --git a/api/xstate/xstate.providedactor.src.md b/api/xstate/xstate.providedactor.src.md new file mode 100644 index 000000000..6fd12c110 --- /dev/null +++ b/api/xstate/xstate.providedactor.src.md @@ -0,0 +1,18 @@ +--- +title: "src" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ProvidedActor.src property + +**Signature:** + +```typescript +src: string; +``` diff --git a/api/xstate/xstate.pure.md b/api/xstate/xstate.pure.md new file mode 100644 index 000000000..43223d90e --- /dev/null +++ b/api/xstate/xstate.pure.md @@ -0,0 +1,32 @@ +--- +title: "pure" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## pure() function + +**Signature:** + +```typescript +export declare function pure(getActions: ({ context, event }: { + context: TContext; + event: TExpressionEvent; +}) => Actions, undefined, TActor, NoInfer, NoInfer, TDelay> | undefined): PureAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| getActions | ({ context, event }: { context: TContext; event: TExpressionEvent; }) => [Actions](./xstate.actions.md)<><TContext, TExpressionEvent, [NoInfer](./xstate.noinfer.md)<><TEvent>, undefined, TActor, [NoInfer](./xstate.noinfer.md)<><TAction>, [NoInfer](./xstate.noinfer.md)<><TGuard>, TDelay> \| undefined | | + +**Returns:** + +[PureAction](./xstate.pureaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TActor, TAction, TGuard, TDelay> + diff --git a/api/xstate/xstate.pureaction._out_taction.md b/api/xstate/xstate.pureaction._out_taction.md new file mode 100644 index 000000000..88cfceaa8 --- /dev/null +++ b/api/xstate/xstate.pureaction._out_taction.md @@ -0,0 +1,18 @@ +--- +title: "_out_TAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PureAction.\_out\_TAction property + +**Signature:** + +```typescript +_out_TAction?: TAction; +``` diff --git a/api/xstate/xstate.pureaction._out_tactor.md b/api/xstate/xstate.pureaction._out_tactor.md new file mode 100644 index 000000000..c9dd3b0aa --- /dev/null +++ b/api/xstate/xstate.pureaction._out_tactor.md @@ -0,0 +1,18 @@ +--- +title: "_out_TActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PureAction.\_out\_TActor property + +**Signature:** + +```typescript +_out_TActor?: TActor; +``` diff --git a/api/xstate/xstate.pureaction._out_tdelay.md b/api/xstate/xstate.pureaction._out_tdelay.md new file mode 100644 index 000000000..8be179763 --- /dev/null +++ b/api/xstate/xstate.pureaction._out_tdelay.md @@ -0,0 +1,18 @@ +--- +title: "_out_TDelay" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PureAction.\_out\_TDelay property + +**Signature:** + +```typescript +_out_TDelay?: TDelay; +``` diff --git a/api/xstate/xstate.pureaction._out_tevent.md b/api/xstate/xstate.pureaction._out_tevent.md new file mode 100644 index 000000000..89899d26f --- /dev/null +++ b/api/xstate/xstate.pureaction._out_tevent.md @@ -0,0 +1,18 @@ +--- +title: "_out_TEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PureAction.\_out\_TEvent property + +**Signature:** + +```typescript +_out_TEvent?: TEvent; +``` diff --git a/api/xstate/xstate.pureaction._out_tguard.md b/api/xstate/xstate.pureaction._out_tguard.md new file mode 100644 index 000000000..f991bcfc2 --- /dev/null +++ b/api/xstate/xstate.pureaction._out_tguard.md @@ -0,0 +1,18 @@ +--- +title: "_out_TGuard" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PureAction.\_out\_TGuard property + +**Signature:** + +```typescript +_out_TGuard?: TGuard; +``` diff --git a/api/xstate/xstate.pureaction.md b/api/xstate/xstate.pureaction.md new file mode 100644 index 000000000..7b6933330 --- /dev/null +++ b/api/xstate/xstate.pureaction.md @@ -0,0 +1,29 @@ +--- +title: "PureAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## PureAction interface + +**Signature:** + +```typescript +export interface PureAction +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_out\_TAction?](./xstate.pureaction._out_taction.md) | | TAction | _(Optional)_ | +| [\_out\_TActor?](./xstate.pureaction._out_tactor.md) | | TActor | _(Optional)_ | +| [\_out\_TDelay?](./xstate.pureaction._out_tdelay.md) | | TDelay | _(Optional)_ | +| [\_out\_TEvent?](./xstate.pureaction._out_tevent.md) | | TEvent | _(Optional)_ | +| [\_out\_TGuard?](./xstate.pureaction._out_tguard.md) | | TGuard | _(Optional)_ | + diff --git a/api/xstate/xstate.raise.md b/api/xstate/xstate.raise.md new file mode 100644 index 000000000..fc56906de --- /dev/null +++ b/api/xstate/xstate.raise.md @@ -0,0 +1,32 @@ +--- +title: "raise" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## raise() function + +Raises an event. This places the event in the internal event queue, so that the event is immediately consumed by the machine in the current step. + +**Signature:** + +```typescript +export declare function raise(eventOrExpr: NoInfer | SendExpr, TEvent>, options?: RaiseActionOptions, NoInfer>): RaiseAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| eventOrExpr | [NoInfer](./xstate.noinfer.md)<><TEvent> \| [SendExpr](./xstate.sendexpr.md)<><TContext, TExpressionEvent, TExpressionAction, [NoInfer](./xstate.noinfer.md)<><TEvent>, TEvent> | | +| options | [RaiseActionOptions](./xstate.raiseactionoptions.md)<><TContext, TExpressionEvent, TExpressionAction, [NoInfer](./xstate.noinfer.md)<><TEvent>, [NoInfer](./xstate.noinfer.md)<><TDelay>> | _(Optional)_ | + +**Returns:** + +[RaiseAction](./xstate.raiseaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> + diff --git a/api/xstate/xstate.raiseaction._out_tdelay.md b/api/xstate/xstate.raiseaction._out_tdelay.md new file mode 100644 index 000000000..6a9735eec --- /dev/null +++ b/api/xstate/xstate.raiseaction._out_tdelay.md @@ -0,0 +1,18 @@ +--- +title: "_out_TDelay" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## RaiseAction.\_out\_TDelay property + +**Signature:** + +```typescript +_out_TDelay?: TDelay; +``` diff --git a/api/xstate/xstate.raiseaction._out_tevent.md b/api/xstate/xstate.raiseaction._out_tevent.md new file mode 100644 index 000000000..2eedada13 --- /dev/null +++ b/api/xstate/xstate.raiseaction._out_tevent.md @@ -0,0 +1,18 @@ +--- +title: "_out_TEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## RaiseAction.\_out\_TEvent property + +**Signature:** + +```typescript +_out_TEvent?: TEvent; +``` diff --git a/api/xstate/xstate.raiseaction.md b/api/xstate/xstate.raiseaction.md new file mode 100644 index 000000000..ee6718624 --- /dev/null +++ b/api/xstate/xstate.raiseaction.md @@ -0,0 +1,26 @@ +--- +title: "RaiseAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## RaiseAction interface + +**Signature:** + +```typescript +export interface RaiseAction +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_out\_TDelay?](./xstate.raiseaction._out_tdelay.md) | | TDelay | _(Optional)_ | +| [\_out\_TEvent?](./xstate.raiseaction._out_tevent.md) | | TEvent | _(Optional)_ | + diff --git a/api/xstate/xstate.raiseactionoptions.delay.md b/api/xstate/xstate.raiseactionoptions.delay.md new file mode 100644 index 000000000..2401ad289 --- /dev/null +++ b/api/xstate/xstate.raiseactionoptions.delay.md @@ -0,0 +1,18 @@ +--- +title: "delay" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## RaiseActionOptions.delay property + +**Signature:** + +```typescript +delay?: Delay | DelayExpr; +``` diff --git a/api/xstate/xstate.raiseactionoptions.id.md b/api/xstate/xstate.raiseactionoptions.id.md new file mode 100644 index 000000000..d2a747858 --- /dev/null +++ b/api/xstate/xstate.raiseactionoptions.id.md @@ -0,0 +1,18 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## RaiseActionOptions.id property + +**Signature:** + +```typescript +id?: string; +``` diff --git a/api/xstate/xstate.raiseactionoptions.md b/api/xstate/xstate.raiseactionoptions.md new file mode 100644 index 000000000..e08ebbfe2 --- /dev/null +++ b/api/xstate/xstate.raiseactionoptions.md @@ -0,0 +1,26 @@ +--- +title: "RaiseActionOptions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## RaiseActionOptions interface + +**Signature:** + +```typescript +export interface RaiseActionOptions +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [delay?](./xstate.raiseactionoptions.delay.md) | | Delay<TDelay> \| [DelayExpr](./xstate.delayexpr.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent> | _(Optional)_ | +| [id?](./xstate.raiseactionoptions.id.md) | | string | _(Optional)_ | + diff --git a/api/xstate/xstate.raiseactionparams.event.md b/api/xstate/xstate.raiseactionparams.event.md new file mode 100644 index 000000000..c35eb65db --- /dev/null +++ b/api/xstate/xstate.raiseactionparams.event.md @@ -0,0 +1,18 @@ +--- +title: "event" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## RaiseActionParams.event property + +**Signature:** + +```typescript +event: TEvent | SendExpr; +``` diff --git a/api/xstate/xstate.raiseactionparams.md b/api/xstate/xstate.raiseactionparams.md new file mode 100644 index 000000000..4c946bd15 --- /dev/null +++ b/api/xstate/xstate.raiseactionparams.md @@ -0,0 +1,26 @@ +--- +title: "RaiseActionParams" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## RaiseActionParams interface + +**Signature:** + +```typescript +export interface RaiseActionParams extends RaiseActionOptions +``` +**Extends:** [RaiseActionOptions](./xstate.raiseactionoptions.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [event](./xstate.raiseactionparams.event.md) | | TEvent \| [SendExpr](./xstate.sendexpr.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TEvent> | | + diff --git a/api/xstate/xstate.resolvedtypegenmeta.md b/api/xstate/xstate.resolvedtypegenmeta.md new file mode 100644 index 000000000..328ce1048 --- /dev/null +++ b/api/xstate/xstate.resolvedtypegenmeta.md @@ -0,0 +1,26 @@ +--- +title: "ResolvedTypegenMeta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ResolvedTypegenMeta interface + +**Signature:** + +```typescript +export interface ResolvedTypegenMeta extends TypegenMeta +``` +**Extends:** [TypegenMeta](./xstate.typegenmeta.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [resolved](./xstate.resolvedtypegenmeta.resolved.md) | | [TypegenMeta](./xstate.typegenmeta.md) & { indexedActors: Record<string, [ProvidedActor](./xstate.providedactor.md)<>>; indexedActions: Record<string, [ParameterizedObject](./xstate.parameterizedobject.md)<>>; indexedEvents: Record<string, [EventObject](./xstate.eventobject.md)<>>; indexedGuards: Record<string, [ParameterizedObject](./xstate.parameterizedobject.md)<>>; indexedDelays: Record<string, [ParameterizedObject](./xstate.parameterizedobject.md)<>>; } | | + diff --git a/api/xstate/xstate.resolvedtypegenmeta.resolved.md b/api/xstate/xstate.resolvedtypegenmeta.resolved.md new file mode 100644 index 000000000..083ca7521 --- /dev/null +++ b/api/xstate/xstate.resolvedtypegenmeta.resolved.md @@ -0,0 +1,24 @@ +--- +title: "resolved" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ResolvedTypegenMeta.resolved property + +**Signature:** + +```typescript +resolved: TypegenMeta & { + indexedActors: Record; + indexedActions: Record; + indexedEvents: Record; + indexedGuards: Record; + indexedDelays: Record; + }; +``` diff --git a/api/xstate/xstate.resolvetypegenmeta.___xstate_typegen_.md b/api/xstate/xstate.resolvetypegenmeta.___xstate_typegen_.md new file mode 100644 index 000000000..ebb8a588d --- /dev/null +++ b/api/xstate/xstate.resolvetypegenmeta.___xstate_typegen_.md @@ -0,0 +1,18 @@ +--- +title: "\"@@xstate/typegen\"" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ResolveTypegenMeta."@@xstate/typegen" property + +**Signature:** + +```typescript +'@@xstate/typegen': TTypesMeta['@@xstate/typegen']; +``` diff --git a/api/xstate/xstate.resolvetypegenmeta.md b/api/xstate/xstate.resolvetypegenmeta.md new file mode 100644 index 000000000..04dfc4c60 --- /dev/null +++ b/api/xstate/xstate.resolvetypegenmeta.md @@ -0,0 +1,26 @@ +--- +title: "ResolveTypegenMeta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ResolveTypegenMeta interface + +**Signature:** + +```typescript +export interface ResolveTypegenMeta +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| ["@@xstate/typegen"](./xstate.resolvetypegenmeta.___xstate_typegen_.md) | | TTypesMeta\['@@xstate/typegen'\] | | +| [resolved](./xstate.resolvetypegenmeta.resolved.md) | | { enabled: TTypesMeta & { indexedActions: IndexParameterizedImplementation<TAction, [Prop](./xstate.prop.md)<><TTypesMeta, 'eventsCausingActions'>>; indexedActors: string extends TActor\['src'\] ? Record<keyof [Prop](./xstate.prop.md)<><TTypesMeta, 'eventsCausingActors'>, { logic: [AnyActorLogic](./xstate.anyactorlogic.md)<>; }> : [IndexByProp](./xstate.indexbyprop.md)<><TActor, 'src'>; indexedEvents: MergeWithInternalEvents<[IndexByType](./xstate.indexbytype.md)<><(string extends TEvent\['type'\] ? never : TEvent) \| GenerateActorEvents<TActor, [Prop](./xstate.prop.md)<><TTypesMeta, 'invokeSrcNameMap'>>>, [Prop](./xstate.prop.md)<><TTypesMeta, 'internalEvents'>>; indexedGuards: IndexParameterizedImplementation<TGuard, [Prop](./xstate.prop.md)<><TTypesMeta, 'eventsCausingGuards'>>; indexedDelays: IndexParameterizedImplementation<WrapIntoParameterizedObject<TDelay>, [Prop](./xstate.prop.md)<><TTypesMeta, 'eventsCausingDelays'>>; tags: string extends TTag ? [Prop](./xstate.prop.md)<><TTypesMeta, 'tags'> : TTag; }; disabled: [TypegenDisabled](./xstate.typegendisabled.md) & AllImplementationsProvided & AllowAllEvents & { indexedActions: [IndexByType](./xstate.indexbytype.md)<><TAction>; indexedActors: [IndexByProp](./xstate.indexbyprop.md)<><TActor, 'src'>; indexedEvents: Record<string, TEvent>; indexedGuards: [IndexByType](./xstate.indexbytype.md)<><TGuard>; indexedDelays: [IndexByType](./xstate.indexbytype.md)<><WrapIntoParameterizedObject<TDelay>>; invokeSrcNameMap: Record<string, string>; tags: TTag; }; }\[[IsNever](./xstate.isnever.md)<><TTypesMeta> extends true ? 'disabled' : TTypesMeta\['@@xstate/typegen'\] extends true ? 'enabled' : 'disabled'\] | | + diff --git a/api/xstate/xstate.resolvetypegenmeta.resolved.md b/api/xstate/xstate.resolvetypegenmeta.resolved.md new file mode 100644 index 000000000..3b875f34b --- /dev/null +++ b/api/xstate/xstate.resolvetypegenmeta.resolved.md @@ -0,0 +1,38 @@ +--- +title: "resolved" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## ResolveTypegenMeta.resolved property + +**Signature:** + +```typescript +resolved: { + enabled: TTypesMeta & { + indexedActions: IndexParameterizedImplementation>; + indexedActors: string extends TActor['src'] ? Record, { + logic: AnyActorLogic; + }> : IndexByProp; + indexedEvents: MergeWithInternalEvents>>, Prop>; + indexedGuards: IndexParameterizedImplementation>; + indexedDelays: IndexParameterizedImplementation, Prop>; + tags: string extends TTag ? Prop : TTag; + }; + disabled: TypegenDisabled & AllImplementationsProvided & AllowAllEvents & { + indexedActions: IndexByType; + indexedActors: IndexByProp; + indexedEvents: Record; + indexedGuards: IndexByType; + indexedDelays: IndexByType>; + invokeSrcNameMap: Record; + tags: TTag; + }; + }[IsNever extends true ? 'disabled' : TTypesMeta['@@xstate/typegen'] extends true ? 'enabled' : 'disabled']; +``` diff --git a/api/xstate/xstate.sendexpr.md b/api/xstate/xstate.sendexpr.md new file mode 100644 index 000000000..22fde1e82 --- /dev/null +++ b/api/xstate/xstate.sendexpr.md @@ -0,0 +1,20 @@ +--- +title: "SendExpr" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SendExpr type + +**Signature:** + +```typescript +export type SendExpr = (args: ActionArgs) => TSentEvent; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ActionArgs](./xstate.actionargs.md) + diff --git a/api/xstate/xstate.sendparent.md b/api/xstate/xstate.sendparent.md new file mode 100644 index 000000000..a331a314f --- /dev/null +++ b/api/xstate/xstate.sendparent.md @@ -0,0 +1,32 @@ +--- +title: "sendParent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## sendParent() function + +Sends an event to this machine's parent. + +**Signature:** + +```typescript +export declare function sendParent(event: TSentEvent | SendExpr, options?: SendToActionOptions): SendToAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | TSentEvent \| [SendExpr](./xstate.sendexpr.md)<><TContext, TExpressionEvent, TExpressionAction, TSentEvent, TEvent> | The event to send to the parent machine. | +| options | [SendToActionOptions](./xstate.sendtoactionoptions.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> | _(Optional)_ Options to pass into the send event. | + +**Returns:** + +[SendToAction](./xstate.sendtoaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> + diff --git a/api/xstate/xstate.sendto.md b/api/xstate/xstate.sendto.md new file mode 100644 index 000000000..5826233ac --- /dev/null +++ b/api/xstate/xstate.sendto.md @@ -0,0 +1,33 @@ +--- +title: "sendTo" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## sendTo() function + +Sends an event to an actor. + +**Signature:** + +```typescript +export declare function sendTo(to: TTargetActor | string | ((args: ActionArgs) => TTargetActor | string), eventOrExpr: EventFrom | SendExpr, EventObject>>, TEvent>, options?: SendToActionOptions, NoInfer>): SendToAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| to | TTargetActor \| string \| ((args: [ActionArgs](./xstate.actionargs.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent>) => TTargetActor \| string) | | +| eventOrExpr | [EventFrom](./xstate.eventfrom.md)<><TTargetActor> \| [SendExpr](./xstate.sendexpr.md)<><TContext, TExpressionEvent, TExpressionAction, [InferEvent](./xstate.inferevent.md)<><[Cast](./xstate.cast.md)<><[EventFrom](./xstate.eventfrom.md)<><TTargetActor>, [EventObject](./xstate.eventobject.md)<>>>, TEvent> | | +| options | [SendToActionOptions](./xstate.sendtoactionoptions.md)<><TContext, TExpressionEvent, TExpressionAction, [NoInfer](./xstate.noinfer.md)<><TEvent>, [NoInfer](./xstate.noinfer.md)<><TDelay>> | _(Optional)_ Send action options - id - The unique send event identifier (used with cancel()). - delay - The number of milliseconds to delay the sending of the event. | + +**Returns:** + +[SendToAction](./xstate.sendtoaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> + diff --git a/api/xstate/xstate.sendtoaction._out_tdelay.md b/api/xstate/xstate.sendtoaction._out_tdelay.md new file mode 100644 index 000000000..c87fa181f --- /dev/null +++ b/api/xstate/xstate.sendtoaction._out_tdelay.md @@ -0,0 +1,18 @@ +--- +title: "_out_TDelay" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SendToAction.\_out\_TDelay property + +**Signature:** + +```typescript +_out_TDelay?: TDelay; +``` diff --git a/api/xstate/xstate.sendtoaction.md b/api/xstate/xstate.sendtoaction.md new file mode 100644 index 000000000..fa5fe4cd9 --- /dev/null +++ b/api/xstate/xstate.sendtoaction.md @@ -0,0 +1,25 @@ +--- +title: "SendToAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SendToAction interface + +**Signature:** + +```typescript +export interface SendToAction +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_out\_TDelay?](./xstate.sendtoaction._out_tdelay.md) | | TDelay | _(Optional)_ | + diff --git a/api/xstate/xstate.sendtoactionoptions.md b/api/xstate/xstate.sendtoactionoptions.md new file mode 100644 index 000000000..992f9bea6 --- /dev/null +++ b/api/xstate/xstate.sendtoactionoptions.md @@ -0,0 +1,20 @@ +--- +title: "SendToActionOptions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SendToActionOptions interface + +**Signature:** + +```typescript +export interface SendToActionOptions extends RaiseActionOptions +``` +**Extends:** [RaiseActionOptions](./xstate.raiseactionoptions.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> + diff --git a/api/xstate/xstate.sendtoactionparams.event.md b/api/xstate/xstate.sendtoactionparams.event.md new file mode 100644 index 000000000..95d497ea6 --- /dev/null +++ b/api/xstate/xstate.sendtoactionparams.event.md @@ -0,0 +1,18 @@ +--- +title: "event" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SendToActionParams.event property + +**Signature:** + +```typescript +event: TSentEvent | SendExpr; +``` diff --git a/api/xstate/xstate.sendtoactionparams.md b/api/xstate/xstate.sendtoactionparams.md new file mode 100644 index 000000000..1270dc2f6 --- /dev/null +++ b/api/xstate/xstate.sendtoactionparams.md @@ -0,0 +1,26 @@ +--- +title: "SendToActionParams" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SendToActionParams interface + +**Signature:** + +```typescript +export interface SendToActionParams extends SendToActionOptions +``` +**Extends:** [SendToActionOptions](./xstate.sendtoactionoptions.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent, TDelay> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [event](./xstate.sendtoactionparams.event.md) | | TSentEvent \| [SendExpr](./xstate.sendexpr.md)<><TContext, TExpressionEvent, TExpressionAction, TSentEvent, TEvent> | | + diff --git a/api/xstate/xstate.simpleorstatenodeconfig.md b/api/xstate/xstate.simpleorstatenodeconfig.md new file mode 100644 index 000000000..59965d639 --- /dev/null +++ b/api/xstate/xstate.simpleorstatenodeconfig.md @@ -0,0 +1,20 @@ +--- +title: "SimpleOrStateNodeConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SimpleOrStateNodeConfig type + +**Signature:** + +```typescript +export type SimpleOrStateNodeConfig = AtomicStateNodeConfig | StateNodeConfig; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [AtomicStateNodeConfig](./xstate.atomicstatenodeconfig.md)<>, [StateNodeConfig](./xstate.statenodeconfig.md)<>, [TODO](./xstate.todo.md) + diff --git a/api/xstate/xstate.simulatedclock.cleartimeout.md b/api/xstate/xstate.simulatedclock.cleartimeout.md new file mode 100644 index 000000000..405bdec61 --- /dev/null +++ b/api/xstate/xstate.simulatedclock.cleartimeout.md @@ -0,0 +1,29 @@ +--- +title: "clearTimeout" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SimulatedClock.clearTimeout() method + +**Signature:** + +```typescript +clearTimeout(id: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| id | number | | + +**Returns:** + +void + diff --git a/api/xstate/xstate.simulatedclock.increment.md b/api/xstate/xstate.simulatedclock.increment.md new file mode 100644 index 000000000..73fa44946 --- /dev/null +++ b/api/xstate/xstate.simulatedclock.increment.md @@ -0,0 +1,29 @@ +--- +title: "increment" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SimulatedClock.increment() method + +**Signature:** + +```typescript +increment(ms: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| ms | number | | + +**Returns:** + +void + diff --git a/api/xstate/xstate.simulatedclock.md b/api/xstate/xstate.simulatedclock.md new file mode 100644 index 000000000..68d479429 --- /dev/null +++ b/api/xstate/xstate.simulatedclock.md @@ -0,0 +1,28 @@ +--- +title: "SimulatedClock" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SimulatedClock interface + +**Signature:** + +```typescript +export interface SimulatedClock extends Clock +``` +**Extends:** Clock + +## Methods + +| Method | Description | +| --- | --- | +| [increment(ms)](./xstate.simulatedclock.increment.md) | | +| [set(ms)](./xstate.simulatedclock.set.md) | | +| [start(speed)](./xstate.simulatedclock.start.md) | | + diff --git a/api/xstate/xstate.simulatedclock.now.md b/api/xstate/xstate.simulatedclock.now.md new file mode 100644 index 000000000..9ab1afd82 --- /dev/null +++ b/api/xstate/xstate.simulatedclock.now.md @@ -0,0 +1,22 @@ +--- +title: "now" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SimulatedClock.now() method + +**Signature:** + +```typescript +now(): number; +``` +**Returns:** + +number + diff --git a/api/xstate/xstate.simulatedclock.set.md b/api/xstate/xstate.simulatedclock.set.md new file mode 100644 index 000000000..a002e8284 --- /dev/null +++ b/api/xstate/xstate.simulatedclock.set.md @@ -0,0 +1,29 @@ +--- +title: "set" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SimulatedClock.set() method + +**Signature:** + +```typescript +set(ms: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| ms | number | | + +**Returns:** + +void + diff --git a/api/xstate/xstate.simulatedclock.settimeout.md b/api/xstate/xstate.simulatedclock.settimeout.md new file mode 100644 index 000000000..fe2ccb67c --- /dev/null +++ b/api/xstate/xstate.simulatedclock.settimeout.md @@ -0,0 +1,30 @@ +--- +title: "setTimeout" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SimulatedClock.setTimeout() method + +**Signature:** + +```typescript +setTimeout(fn: (...args: any[]) => void, timeout: number): number; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| fn | (...args: any\[\]) => void | | +| timeout | number | | + +**Returns:** + +number + diff --git a/api/xstate/xstate.simulatedclock.start.md b/api/xstate/xstate.simulatedclock.start.md new file mode 100644 index 000000000..b29e0edbd --- /dev/null +++ b/api/xstate/xstate.simulatedclock.start.md @@ -0,0 +1,29 @@ +--- +title: "start" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SimulatedClock.start() method + +**Signature:** + +```typescript +start(speed: number): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| speed | number | | + +**Returns:** + +void + diff --git a/api/xstate/xstate.singleorarray.md b/api/xstate/xstate.singleorarray.md new file mode 100644 index 000000000..05aa01ced --- /dev/null +++ b/api/xstate/xstate.singleorarray.md @@ -0,0 +1,18 @@ +--- +title: "SingleOrArray" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SingleOrArray type + +**Signature:** + +```typescript +export type SingleOrArray = readonly T[] | T; +``` diff --git a/api/xstate/xstate.snapshot.md b/api/xstate/xstate.snapshot.md new file mode 100644 index 000000000..5f8873161 --- /dev/null +++ b/api/xstate/xstate.snapshot.md @@ -0,0 +1,34 @@ +--- +title: "Snapshot" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Snapshot type + +**Signature:** + +```typescript +export type Snapshot = { + status: 'active'; + output: undefined; + error: undefined; +} | { + status: 'done'; + output: TOutput; + error: undefined; +} | { + status: 'error'; + output: undefined; + error: unknown; +} | { + status: 'stopped'; + output: undefined; + error: undefined; +}; +``` diff --git a/api/xstate/xstate.snapshotevent.md b/api/xstate/xstate.snapshotevent.md new file mode 100644 index 000000000..416f40ca9 --- /dev/null +++ b/api/xstate/xstate.snapshotevent.md @@ -0,0 +1,27 @@ +--- +title: "SnapshotEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SnapshotEvent interface + +**Signature:** + +```typescript +export interface SnapshotEvent = Snapshot> extends EventObject +``` +**Extends:** [EventObject](./xstate.eventobject.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [snapshot](./xstate.snapshotevent.snapshot.md) | | TSnapshot | | +| [type](./xstate.snapshotevent.type.md) | | \`xstate.snapshot.${string}\` | | + diff --git a/api/xstate/xstate.snapshotevent.snapshot.md b/api/xstate/xstate.snapshotevent.snapshot.md new file mode 100644 index 000000000..d1566df0f --- /dev/null +++ b/api/xstate/xstate.snapshotevent.snapshot.md @@ -0,0 +1,18 @@ +--- +title: "snapshot" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SnapshotEvent.snapshot property + +**Signature:** + +```typescript +snapshot: TSnapshot; +``` diff --git a/api/xstate/xstate.snapshotevent.type.md b/api/xstate/xstate.snapshotevent.type.md new file mode 100644 index 000000000..ea879eb19 --- /dev/null +++ b/api/xstate/xstate.snapshotevent.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SnapshotEvent.type property + +**Signature:** + +```typescript +type: `xstate.snapshot.${string}`; +``` diff --git a/api/xstate/xstate.snapshotfrom.md b/api/xstate/xstate.snapshotfrom.md new file mode 100644 index 000000000..3e59351a0 --- /dev/null +++ b/api/xstate/xstate.snapshotfrom.md @@ -0,0 +1,20 @@ +--- +title: "SnapshotFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SnapshotFrom type + +**Signature:** + +```typescript +export type SnapshotFrom = ReturnTypeOrValue extends infer R ? R extends ActorRef ? TSnapshot : R extends Actor ? SnapshotFrom : R extends StateMachine ? StateFrom : R extends ActorLogic ? ReturnType : R extends ActorContext ? TSnapshot : never : never; +``` +**References:** [ActorRef](./xstate.actorref.md)<>, [Actor](./xstate.actor.md)<>, [SnapshotFrom](./xstate.snapshotfrom.md)<>, [StateMachine](./xstate.statemachine.md)<>, [StateFrom](./xstate.statefrom.md)<>, [ActorLogic](./xstate.actorlogic.md)<>, [ActorContext](./xstate.actorcontext.md) + diff --git a/api/xstate/xstate.spawner.md b/api/xstate/xstate.spawner.md new file mode 100644 index 000000000..88f3424f6 --- /dev/null +++ b/api/xstate/xstate.spawner.md @@ -0,0 +1,27 @@ +--- +title: "Spawner" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Spawner type + +**Signature:** + +```typescript +export type Spawner = IsLiteralString extends true ? (logic: TSrc, ...[options]: SpawnOptions) => ActorRefFrom<(TActor & { + src: TSrc; +})['logic']> : (src: TLogic, options?: { + id?: string; + systemId?: string; + input?: unknown; + syncSnapshot?: boolean; +}) => TLogic extends string ? AnyActorRef : ActorRefFrom; +``` +**References:** [ProvidedActor](./xstate.providedactor.md)<>, [IsLiteralString](./xstate.isliteralstring.md)<>, [ActorRefFrom](./xstate.actorreffrom.md)<>, [AnyActorLogic](./xstate.anyactorlogic.md)<>, [AnyActorRef](./xstate.anyactorref.md) + diff --git a/api/xstate/xstate.specialtargets.md b/api/xstate/xstate.specialtargets.md new file mode 100644 index 000000000..eb96888ee --- /dev/null +++ b/api/xstate/xstate.specialtargets.md @@ -0,0 +1,26 @@ +--- +title: "SpecialTargets" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## SpecialTargets enum + +**Signature:** + +```typescript +export declare enum SpecialTargets +``` + +## Enumeration Members + +| Member | Value | Description | +| --- | --- | --- | +| Internal | "#_internal" | | +| Parent | "#_parent" | | + diff --git a/api/xstate/xstate.state._constructor_.md b/api/xstate/xstate.state._constructor_.md new file mode 100644 index 000000000..f1f42904e --- /dev/null +++ b/api/xstate/xstate.state._constructor_.md @@ -0,0 +1,28 @@ +--- +title: "(constructor)" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.(constructor) + +Creates a new `State` instance that represents the current state of a running machine. + +**Signature:** + +```typescript +constructor(config: StateConfig, machine: AnyStateMachine); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| config | [StateConfig](./xstate.stateconfig.md)<><TContext, TEvent> | | +| machine | [AnyStateMachine](./xstate.anystatemachine.md) | | + diff --git a/api/xstate/xstate.state.can.md b/api/xstate/xstate.state.can.md new file mode 100644 index 000000000..1ee4f72ba --- /dev/null +++ b/api/xstate/xstate.state.can.md @@ -0,0 +1,33 @@ +--- +title: "can" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.can() method + +Determines whether sending the `event` will cause a non-forbidden transition to be selected, even if the transitions have no actions nor change the state value. + +**Signature:** + +```typescript +can(event: TEvent): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| event | TEvent | The event to test | + +**Returns:** + +boolean + +Whether the event will cause a transition + diff --git a/api/xstate/xstate.state.children.md b/api/xstate/xstate.state.children.md new file mode 100644 index 000000000..cc174a9c4 --- /dev/null +++ b/api/xstate/xstate.state.children.md @@ -0,0 +1,20 @@ +--- +title: "children" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.children property + +An object mapping actor names to spawned/invoked actors. + +**Signature:** + +```typescript +children: ComputeChildren; +``` diff --git a/api/xstate/xstate.state.configuration.md b/api/xstate/xstate.state.configuration.md new file mode 100644 index 000000000..06cef7f4c --- /dev/null +++ b/api/xstate/xstate.state.configuration.md @@ -0,0 +1,20 @@ +--- +title: "configuration" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.configuration property + +The enabled state nodes representative of the state value. + +**Signature:** + +```typescript +configuration: Array>; +``` diff --git a/api/xstate/xstate.state.context.md b/api/xstate/xstate.state.context.md new file mode 100644 index 000000000..b74eccea1 --- /dev/null +++ b/api/xstate/xstate.state.context.md @@ -0,0 +1,18 @@ +--- +title: "context" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.context property + +**Signature:** + +```typescript +context: TContext; +``` diff --git a/api/xstate/xstate.state.error.md b/api/xstate/xstate.state.error.md new file mode 100644 index 000000000..d6ccd29fb --- /dev/null +++ b/api/xstate/xstate.state.error.md @@ -0,0 +1,20 @@ +--- +title: "error" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.error property + +The output data of the top-level finite state. + +**Signature:** + +```typescript +error: unknown; +``` diff --git a/api/xstate/xstate.state.from.md b/api/xstate/xstate.state.from.md new file mode 100644 index 000000000..674e5ce9f --- /dev/null +++ b/api/xstate/xstate.state.from.md @@ -0,0 +1,35 @@ +--- +title: "from" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.from() method + +Creates a new State instance for the given `stateValue` and `context`<>. + +**Signature:** + +```typescript +static from(stateValue: State | StateValue, context: TContext | undefined, machine: AnyStateMachine): State; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stateValue | [State](./xstate.state.md)<><TContext, TEvent, [TODO](./xstate.todo.md)<>, any, // tags any> \| [StateValue](./xstate.statevalue.md) | | +| context | TContext \| undefined | | +| machine | [AnyStateMachine](./xstate.anystatemachine.md) | | + +**Returns:** + +[State](./xstate.state.md)<><TContext, TEvent, [TODO](./xstate.todo.md)<>, any, // tags any> + diff --git a/api/xstate/xstate.state.hastag.md b/api/xstate/xstate.state.hastag.md new file mode 100644 index 000000000..accf356e8 --- /dev/null +++ b/api/xstate/xstate.state.hastag.md @@ -0,0 +1,31 @@ +--- +title: "hasTag" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.hasTag() method + +Whether the current state configuration has a state node with the specified `tag`<>. + +**Signature:** + +```typescript +hasTag(tag: TTag): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| tag | TTag | | + +**Returns:** + +boolean + diff --git a/api/xstate/xstate.state.historyvalue.md b/api/xstate/xstate.state.historyvalue.md new file mode 100644 index 000000000..f2f4dc6be --- /dev/null +++ b/api/xstate/xstate.state.historyvalue.md @@ -0,0 +1,18 @@ +--- +title: "historyValue" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.historyValue property + +**Signature:** + +```typescript +historyValue: Readonly>; +``` diff --git a/api/xstate/xstate.state.machine.md b/api/xstate/xstate.state.machine.md new file mode 100644 index 000000000..7f48f3f2d --- /dev/null +++ b/api/xstate/xstate.state.machine.md @@ -0,0 +1,18 @@ +--- +title: "machine" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.machine property + +**Signature:** + +```typescript +machine: AnyStateMachine; +``` diff --git a/api/xstate/xstate.state.matches.md b/api/xstate/xstate.state.matches.md new file mode 100644 index 000000000..70d10798a --- /dev/null +++ b/api/xstate/xstate.state.matches.md @@ -0,0 +1,31 @@ +--- +title: "matches" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.matches() method + +Whether the current state value is a subset of the given parent state value. + +**Signature:** + +```typescript +matches, 'matchesStates'> : StateValue>(parentStateValue: TSV): boolean; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| parentStateValue | TSV | | + +**Returns:** + +boolean + diff --git a/api/xstate/xstate.state.md b/api/xstate/xstate.state.md new file mode 100644 index 000000000..f88e41641 --- /dev/null +++ b/api/xstate/xstate.state.md @@ -0,0 +1,52 @@ +--- +title: "State" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State class + +**Signature:** + +```typescript +export declare class State +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(config, machine)](./xstate.state._constructor_.md) | | Creates a new State instance that represents the current state of a running machine. | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [children](./xstate.state.children.md) | | ComputeChildren<TActor> | An object mapping actor names to spawned/invoked actors. | +| [configuration](./xstate.state.configuration.md) | | Array<[StateNode](./xstate.statenode.md)<><TContext, TEvent>> | The enabled state nodes representative of the state value. | +| [context](./xstate.state.context.md) | | TContext | | +| [error](./xstate.state.error.md) | | unknown | The output data of the top-level finite state. | +| [historyValue](./xstate.state.historyvalue.md) | | Readonly<[HistoryValue](./xstate.historyvalue.md)<><TContext, TEvent>> | | +| [machine](./xstate.state.machine.md) | | [AnyStateMachine](./xstate.anystatemachine.md) | | +| [meta](./xstate.state.meta.md) | readonly | Record<string, any> | | +| [nextEvents](./xstate.state.nextevents.md) | readonly | Array<[EventDescriptor](./xstate.eventdescriptor.md)<><TEvent>> | The next events that will cause a transition from the current state. | +| [status](./xstate.state.status.md) | | 'active' \| 'done' \| 'error' \| 'stopped' | Indicates whether the state is a final state. | +| [tags](./xstate.state.tags.md) | | Set<string> | | +| [value](./xstate.state.value.md) | | [StateValue](./xstate.statevalue.md) | | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [can(event)](./xstate.state.can.md) | | Determines whether sending the event will cause a non-forbidden transition to be selected, even if the transitions have no actions nor change the state value. | +| [from(stateValue, context, machine)](./xstate.state.from.md) | static | Creates a new State instance for the given stateValue and context. | +| [hasTag(tag)](./xstate.state.hastag.md) | | Whether the current state configuration has a state node with the specified tag. | +| [matches(parentStateValue)](./xstate.state.matches.md) | | Whether the current state value is a subset of the given parent state value. | +| [toJSON()](./xstate.state.tojson.md) | | | +| [toStrings(stateValue)](./xstate.state.tostrings.md) | | Returns an array of all the string leaf state node paths. | + diff --git a/api/xstate/xstate.state.meta.md b/api/xstate/xstate.state.meta.md new file mode 100644 index 000000000..496f3f3a0 --- /dev/null +++ b/api/xstate/xstate.state.meta.md @@ -0,0 +1,18 @@ +--- +title: "meta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.meta property + +**Signature:** + +```typescript +get meta(): Record; +``` diff --git a/api/xstate/xstate.state.nextevents.md b/api/xstate/xstate.state.nextevents.md new file mode 100644 index 000000000..c2faec6d7 --- /dev/null +++ b/api/xstate/xstate.state.nextevents.md @@ -0,0 +1,20 @@ +--- +title: "nextEvents" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.nextEvents property + +The next events that will cause a transition from the current state. + +**Signature:** + +```typescript +get nextEvents(): Array>; +``` diff --git a/api/xstate/xstate.state.status.md b/api/xstate/xstate.state.status.md new file mode 100644 index 000000000..22dc0a62a --- /dev/null +++ b/api/xstate/xstate.state.status.md @@ -0,0 +1,20 @@ +--- +title: "status" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.status property + +Indicates whether the state is a final state. + +**Signature:** + +```typescript +status: 'active' | 'done' | 'error' | 'stopped'; +``` diff --git a/api/xstate/xstate.state.tags.md b/api/xstate/xstate.state.tags.md new file mode 100644 index 000000000..a7a66764a --- /dev/null +++ b/api/xstate/xstate.state.tags.md @@ -0,0 +1,18 @@ +--- +title: "tags" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.tags property + +**Signature:** + +```typescript +tags: Set; +``` diff --git a/api/xstate/xstate.state.tojson.md b/api/xstate/xstate.state.tojson.md new file mode 100644 index 000000000..5efe4be93 --- /dev/null +++ b/api/xstate/xstate.state.tojson.md @@ -0,0 +1,25 @@ +--- +title: "toJSON" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.toJSON() method + +**Signature:** + +```typescript +toJSON(): Omit & { + tags: string[]; + meta: Record; + }; +``` +**Returns:** + +Omit<this, "toJSON" \| "meta" \| "tags" \| "configuration" \| "machine" \| "toStrings" \| "matches" \| "hasTag" \| "can" \| "nextEvents"> & { tags: string\[\]; meta: Record<string, any>; } + diff --git a/api/xstate/xstate.state.tostrings.md b/api/xstate/xstate.state.tostrings.md new file mode 100644 index 000000000..aee7947a1 --- /dev/null +++ b/api/xstate/xstate.state.tostrings.md @@ -0,0 +1,31 @@ +--- +title: "toStrings" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.toStrings() method + +Returns an array of all the string leaf state node paths. + +**Signature:** + +```typescript +toStrings(stateValue?: StateValue): string[]; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stateValue | [StateValue](./xstate.statevalue.md) | _(Optional)_ | + +**Returns:** + +string\[\] + diff --git a/api/xstate/xstate.state.value.md b/api/xstate/xstate.state.value.md new file mode 100644 index 000000000..5f7510269 --- /dev/null +++ b/api/xstate/xstate.state.value.md @@ -0,0 +1,18 @@ +--- +title: "value" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## State.value property + +**Signature:** + +```typescript +value: StateValue; +``` diff --git a/api/xstate/xstate.stateconfig.children.md b/api/xstate/xstate.stateconfig.children.md new file mode 100644 index 000000000..5f4174ac5 --- /dev/null +++ b/api/xstate/xstate.stateconfig.children.md @@ -0,0 +1,18 @@ +--- +title: "children" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.children property + +**Signature:** + +```typescript +children: Record>; +``` diff --git a/api/xstate/xstate.stateconfig.configuration.md b/api/xstate/xstate.stateconfig.configuration.md new file mode 100644 index 000000000..667500c20 --- /dev/null +++ b/api/xstate/xstate.stateconfig.configuration.md @@ -0,0 +1,18 @@ +--- +title: "configuration" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.configuration property + +**Signature:** + +```typescript +configuration?: Array>; +``` diff --git a/api/xstate/xstate.stateconfig.context.md b/api/xstate/xstate.stateconfig.context.md new file mode 100644 index 000000000..6a3f8c980 --- /dev/null +++ b/api/xstate/xstate.stateconfig.context.md @@ -0,0 +1,18 @@ +--- +title: "context" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.context property + +**Signature:** + +```typescript +context: TContext; +``` diff --git a/api/xstate/xstate.stateconfig.error.md b/api/xstate/xstate.stateconfig.error.md new file mode 100644 index 000000000..0916764ec --- /dev/null +++ b/api/xstate/xstate.stateconfig.error.md @@ -0,0 +1,18 @@ +--- +title: "error" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.error property + +**Signature:** + +```typescript +error?: unknown; +``` diff --git a/api/xstate/xstate.stateconfig.historyvalue.md b/api/xstate/xstate.stateconfig.historyvalue.md new file mode 100644 index 000000000..e6a8d7ece --- /dev/null +++ b/api/xstate/xstate.stateconfig.historyvalue.md @@ -0,0 +1,18 @@ +--- +title: "historyValue" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.historyValue property + +**Signature:** + +```typescript +historyValue?: HistoryValue; +``` diff --git a/api/xstate/xstate.stateconfig.machine.md b/api/xstate/xstate.stateconfig.machine.md new file mode 100644 index 000000000..656b8778a --- /dev/null +++ b/api/xstate/xstate.stateconfig.machine.md @@ -0,0 +1,18 @@ +--- +title: "machine" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.machine property + +**Signature:** + +```typescript +machine?: StateMachine; +``` diff --git a/api/xstate/xstate.stateconfig.md b/api/xstate/xstate.stateconfig.md new file mode 100644 index 000000000..7f76b68c5 --- /dev/null +++ b/api/xstate/xstate.stateconfig.md @@ -0,0 +1,35 @@ +--- +title: "StateConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig interface + +**Signature:** + +```typescript +export interface StateConfig +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [children](./xstate.stateconfig.children.md) | | Record<string, [ActorRef](./xstate.actorref.md)<><any, any>> | | +| [configuration?](./xstate.stateconfig.configuration.md) | | Array<[StateNode](./xstate.statenode.md)<><TContext, TEvent>> | _(Optional)_ | +| [context](./xstate.stateconfig.context.md) | | TContext | | +| [error?](./xstate.stateconfig.error.md) | | unknown | _(Optional)_ | +| [historyValue?](./xstate.stateconfig.historyvalue.md) | | [HistoryValue](./xstate.historyvalue.md)<><TContext, TEvent> | _(Optional)_ | +| [machine?](./xstate.stateconfig.machine.md) | | [StateMachine](./xstate.statemachine.md)<><TContext, TEvent, any, any, any, any, any, any, any> | _(Optional)_ | +| [meta?](./xstate.stateconfig.meta.md) | | any | _(Optional)_ | +| [output?](./xstate.stateconfig.output.md) | | any | _(Optional)_ | +| [status](./xstate.stateconfig.status.md) | | 'active' \| 'done' \| 'error' \| 'stopped' | | +| [tags?](./xstate.stateconfig.tags.md) | | Set<string> | _(Optional)_ | +| [value](./xstate.stateconfig.value.md) | | [StateValue](./xstate.statevalue.md) | | + diff --git a/api/xstate/xstate.stateconfig.meta.md b/api/xstate/xstate.stateconfig.meta.md new file mode 100644 index 000000000..c101e1e88 --- /dev/null +++ b/api/xstate/xstate.stateconfig.meta.md @@ -0,0 +1,18 @@ +--- +title: "meta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.meta property + +**Signature:** + +```typescript +meta?: any; +``` diff --git a/api/xstate/xstate.stateconfig.output.md b/api/xstate/xstate.stateconfig.output.md new file mode 100644 index 000000000..afae1f5e9 --- /dev/null +++ b/api/xstate/xstate.stateconfig.output.md @@ -0,0 +1,18 @@ +--- +title: "output" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.output property + +**Signature:** + +```typescript +output?: any; +``` diff --git a/api/xstate/xstate.stateconfig.status.md b/api/xstate/xstate.stateconfig.status.md new file mode 100644 index 000000000..a15b3938a --- /dev/null +++ b/api/xstate/xstate.stateconfig.status.md @@ -0,0 +1,18 @@ +--- +title: "status" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.status property + +**Signature:** + +```typescript +status: 'active' | 'done' | 'error' | 'stopped'; +``` diff --git a/api/xstate/xstate.stateconfig.tags.md b/api/xstate/xstate.stateconfig.tags.md new file mode 100644 index 000000000..90417ed2d --- /dev/null +++ b/api/xstate/xstate.stateconfig.tags.md @@ -0,0 +1,18 @@ +--- +title: "tags" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.tags property + +**Signature:** + +```typescript +tags?: Set; +``` diff --git a/api/xstate/xstate.stateconfig.value.md b/api/xstate/xstate.stateconfig.value.md new file mode 100644 index 000000000..d11a93dc6 --- /dev/null +++ b/api/xstate/xstate.stateconfig.value.md @@ -0,0 +1,18 @@ +--- +title: "value" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateConfig.value property + +**Signature:** + +```typescript +value: StateValue; +``` diff --git a/api/xstate/xstate.statefrom.md b/api/xstate/xstate.statefrom.md new file mode 100644 index 000000000..041b0682a --- /dev/null +++ b/api/xstate/xstate.statefrom.md @@ -0,0 +1,20 @@ +--- +title: "StateFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateFrom type + +**Signature:** + +```typescript +export type StateFrom AnyStateMachine)> = T extends AnyStateMachine ? ReturnType : T extends (...args: any[]) => AnyStateMachine ? ReturnType['transition']> : never; +``` +**References:** [AnyStateMachine](./xstate.anystatemachine.md) + diff --git a/api/xstate/xstate.statein.md b/api/xstate/xstate.statein.md new file mode 100644 index 000000000..507f3ee01 --- /dev/null +++ b/api/xstate/xstate.statein.md @@ -0,0 +1,29 @@ +--- +title: "stateIn" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## stateIn() function + +**Signature:** + +```typescript +export declare function stateIn(stateValue: StateValue): GuardPredicate; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stateValue | [StateValue](./xstate.statevalue.md) | | + +**Returns:** + +GuardPredicate<TContext, TExpressionEvent, TExpressionGuard, any> + diff --git a/api/xstate/xstate.statekey.md b/api/xstate/xstate.statekey.md new file mode 100644 index 000000000..2526f00b9 --- /dev/null +++ b/api/xstate/xstate.statekey.md @@ -0,0 +1,20 @@ +--- +title: "StateKey" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateKey type + +**Signature:** + +```typescript +export type StateKey = string | AnyState; +``` +**References:** [AnyState](./xstate.anystate.md) + diff --git a/api/xstate/xstate.statelike.context.md b/api/xstate/xstate.statelike.context.md new file mode 100644 index 000000000..fcf34d3ae --- /dev/null +++ b/api/xstate/xstate.statelike.context.md @@ -0,0 +1,18 @@ +--- +title: "context" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateLike.context property + +**Signature:** + +```typescript +context: TContext; +``` diff --git a/api/xstate/xstate.statelike.event.md b/api/xstate/xstate.statelike.event.md new file mode 100644 index 000000000..b6b00eeed --- /dev/null +++ b/api/xstate/xstate.statelike.event.md @@ -0,0 +1,18 @@ +--- +title: "event" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateLike.event property + +**Signature:** + +```typescript +event: EventObject; +``` diff --git a/api/xstate/xstate.statelike.md b/api/xstate/xstate.statelike.md new file mode 100644 index 000000000..0fddb2ea3 --- /dev/null +++ b/api/xstate/xstate.statelike.md @@ -0,0 +1,27 @@ +--- +title: "StateLike" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateLike interface + +**Signature:** + +```typescript +export interface StateLike +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [context](./xstate.statelike.context.md) | | TContext | | +| [event](./xstate.statelike.event.md) | | [EventObject](./xstate.eventobject.md) | | +| [value](./xstate.statelike.value.md) | | [StateValue](./xstate.statevalue.md) | | + diff --git a/api/xstate/xstate.statelike.value.md b/api/xstate/xstate.statelike.value.md new file mode 100644 index 000000000..b97d10eb0 --- /dev/null +++ b/api/xstate/xstate.statelike.value.md @@ -0,0 +1,18 @@ +--- +title: "value" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateLike.value property + +**Signature:** + +```typescript +value: StateValue; +``` diff --git a/api/xstate/xstate.statemachine.__taction.md b/api/xstate/xstate.statemachine.__taction.md new file mode 100644 index 000000000..fdc7b8d4b --- /dev/null +++ b/api/xstate/xstate.statemachine.__taction.md @@ -0,0 +1,23 @@ +--- +title: "__TAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TAction property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TAction: TAction; +``` diff --git a/api/xstate/xstate.statemachine.__tactor.md b/api/xstate/xstate.statemachine.__tactor.md new file mode 100644 index 000000000..f42c2da22 --- /dev/null +++ b/api/xstate/xstate.statemachine.__tactor.md @@ -0,0 +1,23 @@ +--- +title: "__TActor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TActor property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TActor: TActor; +``` diff --git a/api/xstate/xstate.statemachine.__tcontext.md b/api/xstate/xstate.statemachine.__tcontext.md new file mode 100644 index 000000000..b859152a8 --- /dev/null +++ b/api/xstate/xstate.statemachine.__tcontext.md @@ -0,0 +1,23 @@ +--- +title: "__TContext" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TContext property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TContext: TContext; +``` diff --git a/api/xstate/xstate.statemachine.__tdelay.md b/api/xstate/xstate.statemachine.__tdelay.md new file mode 100644 index 000000000..bcb012e0c --- /dev/null +++ b/api/xstate/xstate.statemachine.__tdelay.md @@ -0,0 +1,23 @@ +--- +title: "__TDelay" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TDelay property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TDelay: TDelay; +``` diff --git a/api/xstate/xstate.statemachine.__tevent.md b/api/xstate/xstate.statemachine.__tevent.md new file mode 100644 index 000000000..c49209d80 --- /dev/null +++ b/api/xstate/xstate.statemachine.__tevent.md @@ -0,0 +1,23 @@ +--- +title: "__TEvent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TEvent property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TEvent: TEvent; +``` diff --git a/api/xstate/xstate.statemachine.__tguard.md b/api/xstate/xstate.statemachine.__tguard.md new file mode 100644 index 000000000..5892fc6f7 --- /dev/null +++ b/api/xstate/xstate.statemachine.__tguard.md @@ -0,0 +1,23 @@ +--- +title: "__TGuard" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TGuard property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TGuard: TGuard; +``` diff --git a/api/xstate/xstate.statemachine.__tinput.md b/api/xstate/xstate.statemachine.__tinput.md new file mode 100644 index 000000000..320a7bfd7 --- /dev/null +++ b/api/xstate/xstate.statemachine.__tinput.md @@ -0,0 +1,23 @@ +--- +title: "__TInput" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TInput property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TInput: TInput; +``` diff --git a/api/xstate/xstate.statemachine.__toutput.md b/api/xstate/xstate.statemachine.__toutput.md new file mode 100644 index 000000000..aabd56579 --- /dev/null +++ b/api/xstate/xstate.statemachine.__toutput.md @@ -0,0 +1,23 @@ +--- +title: "__TOutput" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TOutput property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TOutput: TOutput; +``` diff --git a/api/xstate/xstate.statemachine.__tresolvedtypesmeta.md b/api/xstate/xstate.statemachine.__tresolvedtypesmeta.md new file mode 100644 index 000000000..c36c16f48 --- /dev/null +++ b/api/xstate/xstate.statemachine.__tresolvedtypesmeta.md @@ -0,0 +1,23 @@ +--- +title: "__TResolvedTypesMeta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TResolvedTypesMeta property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TResolvedTypesMeta: TResolvedTypesMeta; +``` diff --git a/api/xstate/xstate.statemachine.__ttag.md b/api/xstate/xstate.statemachine.__ttag.md new file mode 100644 index 000000000..49a2a439b --- /dev/null +++ b/api/xstate/xstate.statemachine.__ttag.md @@ -0,0 +1,23 @@ +--- +title: "__TTag" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_TTag property + +> Warning: This API is now obsolete. +> +> an internal property acting as a "phantom" type, not meant to be used at runtime +> + +**Signature:** + +```typescript +__TTag: TTag; +``` diff --git a/api/xstate/xstate.statemachine.__xstatenode.md b/api/xstate/xstate.statemachine.__xstatenode.md new file mode 100644 index 000000000..d9e29e784 --- /dev/null +++ b/api/xstate/xstate.statemachine.__xstatenode.md @@ -0,0 +1,18 @@ +--- +title: "__xstatenode" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.\_\_xstatenode property + +**Signature:** + +```typescript +__xstatenode: true; +``` diff --git a/api/xstate/xstate.statemachine._constructor_.md b/api/xstate/xstate.statemachine._constructor_.md new file mode 100644 index 000000000..50447b30e --- /dev/null +++ b/api/xstate/xstate.statemachine._constructor_.md @@ -0,0 +1,29 @@ +--- +title: "(constructor)" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.(constructor) + +Constructs a new instance of the `StateMachine` class + +**Signature:** + +```typescript +constructor( + config: MachineConfig, implementations?: MachineImplementationsSimplified); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| config | [MachineConfig](./xstate.machineconfig.md)<><TContext, TEvent, any, any, any, any, any, any, TOutput, any> | | +| implementations | [MachineImplementationsSimplified](./xstate.machineimplementationssimplified.md)<><TContext, TEvent> | _(Optional)_ | + diff --git a/api/xstate/xstate.statemachine.config.md b/api/xstate/xstate.statemachine.config.md new file mode 100644 index 000000000..cc7affbb5 --- /dev/null +++ b/api/xstate/xstate.statemachine.config.md @@ -0,0 +1,20 @@ +--- +title: "config" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.config property + +The raw config used to create the machine. + +**Signature:** + +```typescript +config: MachineConfig; +``` diff --git a/api/xstate/xstate.statemachine.createstate.md b/api/xstate/xstate.statemachine.createstate.md new file mode 100644 index 000000000..514437ce6 --- /dev/null +++ b/api/xstate/xstate.statemachine.createstate.md @@ -0,0 +1,29 @@ +--- +title: "createState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.createState() method + +**Signature:** + +```typescript +createState(stateConfig: MachineSnapshot | StateConfig): MachineSnapshot; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stateConfig | [MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> \| [StateConfig](./xstate.stateconfig.md)<><TContext, TEvent> | | + +**Returns:** + +[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> + diff --git a/api/xstate/xstate.statemachine.definition.md b/api/xstate/xstate.statemachine.definition.md new file mode 100644 index 000000000..3af9270d3 --- /dev/null +++ b/api/xstate/xstate.statemachine.definition.md @@ -0,0 +1,18 @@ +--- +title: "definition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.definition property + +**Signature:** + +```typescript +get definition(): StateMachineDefinition; +``` diff --git a/api/xstate/xstate.statemachine.events.md b/api/xstate/xstate.statemachine.events.md new file mode 100644 index 000000000..f1d24aa4b --- /dev/null +++ b/api/xstate/xstate.statemachine.events.md @@ -0,0 +1,18 @@ +--- +title: "events" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.events property + +**Signature:** + +```typescript +events: Array; +``` diff --git a/api/xstate/xstate.statemachine.getinitialstate.md b/api/xstate/xstate.statemachine.getinitialstate.md new file mode 100644 index 000000000..24f449ca8 --- /dev/null +++ b/api/xstate/xstate.statemachine.getinitialstate.md @@ -0,0 +1,32 @@ +--- +title: "getInitialState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.getInitialState() method + +Returns the initial `State` instance, with reference to `self` as an `ActorRef`<>. + +**Signature:** + +```typescript +getInitialState(actorCtx: ActorContext, TEvent>, input?: TInput): MachineSnapshot; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| actorCtx | [ActorContext](./xstate.actorcontext.md)<><[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>, TEvent> | | +| input | TInput | _(Optional)_ | + +**Returns:** + +[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> + diff --git a/api/xstate/xstate.statemachine.getpersistedstate.md b/api/xstate/xstate.statemachine.getpersistedstate.md new file mode 100644 index 000000000..0b11666eb --- /dev/null +++ b/api/xstate/xstate.statemachine.getpersistedstate.md @@ -0,0 +1,29 @@ +--- +title: "getPersistedState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.getPersistedState() method + +**Signature:** + +```typescript +getPersistedState(state: MachineSnapshot): PersistedMachineState; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| state | [MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> | | + +**Returns:** + +[PersistedMachineState](./xstate.persistedmachinestate.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> + diff --git a/api/xstate/xstate.statemachine.getstatenodebyid.md b/api/xstate/xstate.statemachine.getstatenodebyid.md new file mode 100644 index 000000000..4286a92dd --- /dev/null +++ b/api/xstate/xstate.statemachine.getstatenodebyid.md @@ -0,0 +1,29 @@ +--- +title: "getStateNodeById" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.getStateNodeById() method + +**Signature:** + +```typescript +getStateNodeById(stateId: string): StateNode; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stateId | string | | + +**Returns:** + +[StateNode](./xstate.statenode.md)<><TContext, TEvent> + diff --git a/api/xstate/xstate.statemachine.gettransitiondata.md b/api/xstate/xstate.statemachine.gettransitiondata.md new file mode 100644 index 000000000..4bcdfa02d --- /dev/null +++ b/api/xstate/xstate.statemachine.gettransitiondata.md @@ -0,0 +1,30 @@ +--- +title: "getTransitionData" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.getTransitionData() method + +**Signature:** + +```typescript +getTransitionData(state: MachineSnapshot, event: TEvent): Array>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| state | [MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> | | +| event | TEvent | | + +**Returns:** + +Array<[TransitionDefinition](./xstate.transitiondefinition.md)<><TContext, TEvent>> + diff --git a/api/xstate/xstate.statemachine.id.md b/api/xstate/xstate.statemachine.id.md new file mode 100644 index 000000000..9db6580ec --- /dev/null +++ b/api/xstate/xstate.statemachine.id.md @@ -0,0 +1,18 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.id property + +**Signature:** + +```typescript +id: string; +``` diff --git a/api/xstate/xstate.statemachine.idmap.md b/api/xstate/xstate.statemachine.idmap.md new file mode 100644 index 000000000..8a6ac23a8 --- /dev/null +++ b/api/xstate/xstate.statemachine.idmap.md @@ -0,0 +1,18 @@ +--- +title: "idMap" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.idMap property + +**Signature:** + +```typescript +idMap: Map>; +``` diff --git a/api/xstate/xstate.statemachine.implementations.md b/api/xstate/xstate.statemachine.implementations.md new file mode 100644 index 000000000..2f8ab7b64 --- /dev/null +++ b/api/xstate/xstate.statemachine.implementations.md @@ -0,0 +1,18 @@ +--- +title: "implementations" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.implementations property + +**Signature:** + +```typescript +implementations: MachineImplementationsSimplified; +``` diff --git a/api/xstate/xstate.statemachine.md b/api/xstate/xstate.statemachine.md new file mode 100644 index 000000000..56613e23b --- /dev/null +++ b/api/xstate/xstate.statemachine.md @@ -0,0 +1,70 @@ +--- +title: "StateMachine" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine class + +**Signature:** + +```typescript +export declare class StateMachine, TActor, TAction, TGuard, TDelay, TTag>> implements ActorLogic, TEvent, TInput, PersistedMachineState, TODO> +``` +**Implements:** [ActorLogic](./xstate.actorlogic.md)<><[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>, TEvent, TInput, [PersistedMachineState](./xstate.persistedmachinestate.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>, [TODO](./xstate.todo.md)<>> + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(config, implementations)](./xstate.statemachine._constructor_.md) | | Constructs a new instance of the StateMachine class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [\_\_TAction](./xstate.statemachine.__taction.md) | | TAction | | +| [\_\_TActor](./xstate.statemachine.__tactor.md) | | TActor | | +| [\_\_TContext](./xstate.statemachine.__tcontext.md) | | TContext | | +| [\_\_TDelay](./xstate.statemachine.__tdelay.md) | | TDelay | | +| [\_\_TEvent](./xstate.statemachine.__tevent.md) | | TEvent | | +| [\_\_TGuard](./xstate.statemachine.__tguard.md) | | TGuard | | +| [\_\_TInput](./xstate.statemachine.__tinput.md) | | TInput | | +| [\_\_TOutput](./xstate.statemachine.__toutput.md) | | TOutput | | +| [\_\_TResolvedTypesMeta](./xstate.statemachine.__tresolvedtypesmeta.md) | | TResolvedTypesMeta | | +| [\_\_TTag](./xstate.statemachine.__ttag.md) | | TTag | | +| [\_\_xstatenode](./xstate.statemachine.__xstatenode.md) | | true | | +| [config](./xstate.statemachine.config.md) | | [MachineConfig](./xstate.machineconfig.md)<><TContext, TEvent, any, any, any, any, any, any, TOutput, any> | The raw config used to create the machine. | +| [definition](./xstate.statemachine.definition.md) | readonly | [StateMachineDefinition](./xstate.statemachinedefinition.md)<><TContext, TEvent> | | +| [events](./xstate.statemachine.events.md) | | Array<TEvent\['type'\]> | | +| [id](./xstate.statemachine.id.md) | | string | | +| [idMap](./xstate.statemachine.idmap.md) | | Map<string, [StateNode](./xstate.statenode.md)<><TContext, TEvent>> | | +| [implementations](./xstate.statemachine.implementations.md) | | [MachineImplementationsSimplified](./xstate.machineimplementationssimplified.md)<><TContext, TEvent> | | +| [root](./xstate.statemachine.root.md) | | [StateNode](./xstate.statenode.md)<><TContext, TEvent> | | +| [states](./xstate.statemachine.states.md) | | [StateNode](./xstate.statenode.md)<><TContext, TEvent>\['states'\] | | +| [types](./xstate.statemachine.types.md) | | [MachineTypes](./xstate.machinetypes.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay, TTag, TInput, TOutput, TResolvedTypesMeta> | | +| [version?](./xstate.statemachine.version.md) | | string | _(Optional)_ The machine's own version. | + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [createState(stateConfig)](./xstate.statemachine.createstate.md) | | | +| [getInitialState(actorCtx, input)](./xstate.statemachine.getinitialstate.md) | | Returns the initial State instance, with reference to self as an ActorRef. | +| [getPersistedState(state)](./xstate.statemachine.getpersistedstate.md) | | | +| [getStateNodeById(stateId)](./xstate.statemachine.getstatenodebyid.md) | | | +| [getTransitionData(state, event)](./xstate.statemachine.gettransitiondata.md) | | | +| [microstep(state, event, actorCtx)](./xstate.statemachine.microstep.md) | | Determines the next state given the current state and event. Calculates a microstep. | +| [provide(implementations)](./xstate.statemachine.provide.md) | | Clones this state machine with the provided implementations and merges the context (if provided). | +| [resolveState(state)](./xstate.statemachine.resolvestate.md) | |

Resolves the given state to a new State instance relative to this machine.

This ensures that .nextEvents represent the correct values.

| +| [resolveStateValue(stateValue, \[context\])](./xstate.statemachine.resolvestatevalue.md) | | | +| [restoreState(snapshot, \_actorCtx)](./xstate.statemachine.restorestate.md) | | | +| [start(state)](./xstate.statemachine.start.md) | | | +| [toJSON()](./xstate.statemachine.tojson.md) | | | +| [transition(state, event, actorCtx)](./xstate.statemachine.transition.md) | | Determines the next state given the current state and received event. Calculates a full macrostep from all microsteps. | + diff --git a/api/xstate/xstate.statemachine.microstep.md b/api/xstate/xstate.statemachine.microstep.md new file mode 100644 index 000000000..e36bfa97e --- /dev/null +++ b/api/xstate/xstate.statemachine.microstep.md @@ -0,0 +1,33 @@ +--- +title: "microstep" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.microstep() method + +Determines the next state given the current `state` and `event`<>. Calculates a microstep. + +**Signature:** + +```typescript +microstep(state: MachineSnapshot, event: TEvent, actorCtx: AnyActorContext): Array>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| state | [MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> | The current state | +| event | TEvent | The received event | +| actorCtx | [AnyActorContext](./xstate.anyactorcontext.md) | | + +**Returns:** + +Array<[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>> + diff --git a/api/xstate/xstate.statemachine.provide.md b/api/xstate/xstate.statemachine.provide.md new file mode 100644 index 000000000..0bd809306 --- /dev/null +++ b/api/xstate/xstate.statemachine.provide.md @@ -0,0 +1,33 @@ +--- +title: "provide" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.provide() method + +Clones this state machine with the provided implementations and merges the `context` (if provided). + +**Signature:** + +```typescript +provide(implementations: InternalMachineImplementations): StateMachine extends false ? MarkAllImplementationsAsProvided : TResolvedTypesMeta>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| implementations | [InternalMachineImplementations](./xstate.internalmachineimplementations.md)<><TContext, TEvent, TActor, TAction, TDelay, TResolvedTypesMeta, true> | Options (actions, guards, actors, delays, context) to recursively merge with the existing options. | + +**Returns:** + +[StateMachine](./xstate.statemachine.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay, TTag, TInput, TOutput, [AreAllImplementationsAssumedToBeProvided](./xstate.areallimplementationsassumedtobeprovided.md)<><TResolvedTypesMeta> extends false ? [MarkAllImplementationsAsProvided](./xstate.markallimplementationsasprovided.md)<><TResolvedTypesMeta> : TResolvedTypesMeta> + +A new `StateMachine` instance with the provided implementations. + diff --git a/api/xstate/xstate.statemachine.resolvestate.md b/api/xstate/xstate.statemachine.resolvestate.md new file mode 100644 index 000000000..f37ec584d --- /dev/null +++ b/api/xstate/xstate.statemachine.resolvestate.md @@ -0,0 +1,33 @@ +--- +title: "resolveState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.resolveState() method + +Resolves the given `state` to a new `State` instance relative to this machine. + +This ensures that `.nextEvents` represent the correct values. + +**Signature:** + +```typescript +resolveState(state: State): MachineSnapshot; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| state | [State](./xstate.state.md)<><TContext, TEvent, TActor, TTag, TResolvedTypesMeta> | The state to resolve | + +**Returns:** + +[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> + diff --git a/api/xstate/xstate.statemachine.resolvestatevalue.md b/api/xstate/xstate.statemachine.resolvestatevalue.md new file mode 100644 index 000000000..4a04dd967 --- /dev/null +++ b/api/xstate/xstate.statemachine.resolvestatevalue.md @@ -0,0 +1,30 @@ +--- +title: "resolveStateValue" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.resolveStateValue() method + +**Signature:** + +```typescript +resolveStateValue(stateValue: StateValue, ...[context]: Equals extends true ? [] : [TContext]): MachineSnapshot; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| stateValue | [StateValue](./xstate.statevalue.md) | | +| \[context\] | [Equals](./xstate.equals.md)<><TContext, [MachineContext](./xstate.machinecontext.md)<>> extends true ? \[\] : \[TContext\] | | + +**Returns:** + +[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> + diff --git a/api/xstate/xstate.statemachine.restorestate.md b/api/xstate/xstate.statemachine.restorestate.md new file mode 100644 index 000000000..03811a734 --- /dev/null +++ b/api/xstate/xstate.statemachine.restorestate.md @@ -0,0 +1,30 @@ +--- +title: "restoreState" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.restoreState() method + +**Signature:** + +```typescript +restoreState(snapshot: PersistedMachineState, _actorCtx: ActorContext, TEvent>): MachineSnapshot; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| snapshot | [PersistedMachineState](./xstate.persistedmachinestate.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> | | +| \_actorCtx | [ActorContext](./xstate.actorcontext.md)<><[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta>, TEvent> | | + +**Returns:** + +[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> + diff --git a/api/xstate/xstate.statemachine.root.md b/api/xstate/xstate.statemachine.root.md new file mode 100644 index 000000000..23e7f3e27 --- /dev/null +++ b/api/xstate/xstate.statemachine.root.md @@ -0,0 +1,18 @@ +--- +title: "root" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.root property + +**Signature:** + +```typescript +root: StateNode; +``` diff --git a/api/xstate/xstate.statemachine.start.md b/api/xstate/xstate.statemachine.start.md new file mode 100644 index 000000000..6cda06de0 --- /dev/null +++ b/api/xstate/xstate.statemachine.start.md @@ -0,0 +1,29 @@ +--- +title: "start" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.start() method + +**Signature:** + +```typescript +start(state: MachineSnapshot): void; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| state | [MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> | | + +**Returns:** + +void + diff --git a/api/xstate/xstate.statemachine.states.md b/api/xstate/xstate.statemachine.states.md new file mode 100644 index 000000000..bdb27cb83 --- /dev/null +++ b/api/xstate/xstate.statemachine.states.md @@ -0,0 +1,18 @@ +--- +title: "states" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.states property + +**Signature:** + +```typescript +states: StateNode['states']; +``` diff --git a/api/xstate/xstate.statemachine.tojson.md b/api/xstate/xstate.statemachine.tojson.md new file mode 100644 index 000000000..fb6c3f849 --- /dev/null +++ b/api/xstate/xstate.statemachine.tojson.md @@ -0,0 +1,22 @@ +--- +title: "toJSON" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.toJSON() method + +**Signature:** + +```typescript +toJSON(): StateMachineDefinition; +``` +**Returns:** + +[StateMachineDefinition](./xstate.statemachinedefinition.md)<><TContext, TEvent> + diff --git a/api/xstate/xstate.statemachine.transition.md b/api/xstate/xstate.statemachine.transition.md new file mode 100644 index 000000000..945cf773b --- /dev/null +++ b/api/xstate/xstate.statemachine.transition.md @@ -0,0 +1,33 @@ +--- +title: "transition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.transition() method + +Determines the next state given the current `state` and received `event`<>. Calculates a full macrostep from all microsteps. + +**Signature:** + +```typescript +transition(state: MachineSnapshot, event: TEvent, actorCtx: ActorContext): MachineSnapshot; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| state | [MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> | The current State instance or state value | +| event | TEvent | The received event | +| actorCtx | [ActorContext](./xstate.actorcontext.md)<><typeof state, TEvent> | | + +**Returns:** + +[MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, TActor, TTag, TOutput, TResolvedTypesMeta> + diff --git a/api/xstate/xstate.statemachine.types.md b/api/xstate/xstate.statemachine.types.md new file mode 100644 index 000000000..b0fc876f2 --- /dev/null +++ b/api/xstate/xstate.statemachine.types.md @@ -0,0 +1,18 @@ +--- +title: "types" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.types property + +**Signature:** + +```typescript +types: MachineTypes; +``` diff --git a/api/xstate/xstate.statemachine.version.md b/api/xstate/xstate.statemachine.version.md new file mode 100644 index 000000000..add4f6d00 --- /dev/null +++ b/api/xstate/xstate.statemachine.version.md @@ -0,0 +1,20 @@ +--- +title: "version" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachine.version property + +The machine's own version. + +**Signature:** + +```typescript +version?: string; +``` diff --git a/api/xstate/xstate.statemachinedefinition.md b/api/xstate/xstate.statemachinedefinition.md new file mode 100644 index 000000000..8822f27fb --- /dev/null +++ b/api/xstate/xstate.statemachinedefinition.md @@ -0,0 +1,20 @@ +--- +title: "StateMachineDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateMachineDefinition interface + +**Signature:** + +```typescript +export interface StateMachineDefinition extends StateNodeDefinition +``` +**Extends:** [StateNodeDefinition](./xstate.statenodedefinition.md)<><TContext, TEvent> + diff --git a/api/xstate/xstate.statenode._constructor_.md b/api/xstate/xstate.statenode._constructor_.md new file mode 100644 index 000000000..8a685e67b --- /dev/null +++ b/api/xstate/xstate.statenode._constructor_.md @@ -0,0 +1,34 @@ +--- +title: "(constructor)" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.(constructor) + +Constructs a new instance of the `StateNode` class + +**Signature:** + +```typescript +constructor( + config: StateNodeConfig, options: StateNodeOptions); +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| config | [StateNodeConfig](./xstate.statenodeconfig.md)<><TContext, TEvent, [TODO](./xstate.todo.md)<>, // actions [TODO](./xstate.todo.md)<>, // actors [TODO](./xstate.todo.md)<>, // output [TODO](./xstate.todo.md)<>, // guards [TODO](./xstate.todo.md)<>, // delays [TODO](./xstate.todo.md)<>> | | +| options | StateNodeOptions<TContext, TEvent> | | + diff --git a/api/xstate/xstate.statenode._initialize.md b/api/xstate/xstate.statenode._initialize.md new file mode 100644 index 000000000..09774a14f --- /dev/null +++ b/api/xstate/xstate.statenode._initialize.md @@ -0,0 +1,22 @@ +--- +title: "_initialize" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.\_initialize() method + +**Signature:** + +```typescript +_initialize(): void; +``` +**Returns:** + +void + diff --git a/api/xstate/xstate.statenode.after.md b/api/xstate/xstate.statenode.after.md new file mode 100644 index 000000000..77cd0b233 --- /dev/null +++ b/api/xstate/xstate.statenode.after.md @@ -0,0 +1,18 @@ +--- +title: "after" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.after property + +**Signature:** + +```typescript +get after(): Array>; +``` diff --git a/api/xstate/xstate.statenode.always.md b/api/xstate/xstate.statenode.always.md new file mode 100644 index 000000000..b375e43bf --- /dev/null +++ b/api/xstate/xstate.statenode.always.md @@ -0,0 +1,18 @@ +--- +title: "always" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.always property + +**Signature:** + +```typescript +always?: Array>; +``` diff --git a/api/xstate/xstate.statenode.config.md b/api/xstate/xstate.statenode.config.md new file mode 100644 index 000000000..6dec64e16 --- /dev/null +++ b/api/xstate/xstate.statenode.config.md @@ -0,0 +1,25 @@ +--- +title: "config" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.config property + +The raw config used to create the machine. + +**Signature:** + +```typescript +config: StateNodeConfig; +``` diff --git a/api/xstate/xstate.statenode.definition.md b/api/xstate/xstate.statenode.definition.md new file mode 100644 index 000000000..9fd5c6894 --- /dev/null +++ b/api/xstate/xstate.statenode.definition.md @@ -0,0 +1,20 @@ +--- +title: "definition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.definition property + +The well-structured state node definition. + +**Signature:** + +```typescript +get definition(): StateNodeDefinition; +``` diff --git a/api/xstate/xstate.statenode.description.md b/api/xstate/xstate.statenode.description.md new file mode 100644 index 000000000..03a11bfee --- /dev/null +++ b/api/xstate/xstate.statenode.description.md @@ -0,0 +1,18 @@ +--- +title: "description" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.description property + +**Signature:** + +```typescript +description?: string; +``` diff --git a/api/xstate/xstate.statenode.entry.md b/api/xstate/xstate.statenode.entry.md new file mode 100644 index 000000000..f6d525d25 --- /dev/null +++ b/api/xstate/xstate.statenode.entry.md @@ -0,0 +1,20 @@ +--- +title: "entry" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.entry property + +The action(s) to be executed upon entering the state node. + +**Signature:** + +```typescript +entry: UnknownAction[]; +``` diff --git a/api/xstate/xstate.statenode.events.md b/api/xstate/xstate.statenode.events.md new file mode 100644 index 000000000..03c46f635 --- /dev/null +++ b/api/xstate/xstate.statenode.events.md @@ -0,0 +1,20 @@ +--- +title: "events" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.events property + +All the event types accepted by this state node and its descendants. + +**Signature:** + +```typescript +get events(): Array; +``` diff --git a/api/xstate/xstate.statenode.exit.md b/api/xstate/xstate.statenode.exit.md new file mode 100644 index 000000000..ac0a0403a --- /dev/null +++ b/api/xstate/xstate.statenode.exit.md @@ -0,0 +1,20 @@ +--- +title: "exit" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.exit property + +The action(s) to be executed upon exiting the state node. + +**Signature:** + +```typescript +exit: UnknownAction[]; +``` diff --git a/api/xstate/xstate.statenode.history.md b/api/xstate/xstate.statenode.history.md new file mode 100644 index 000000000..0fc34445f --- /dev/null +++ b/api/xstate/xstate.statenode.history.md @@ -0,0 +1,22 @@ +--- +title: "history" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.history property + +The type of history on this state node. Can be: + +- `'shallow'` - recalls only top-level historical state value - `'deep'` - recalls historical state value at all levels + +**Signature:** + +```typescript +history: false | 'shallow' | 'deep'; +``` diff --git a/api/xstate/xstate.statenode.id.md b/api/xstate/xstate.statenode.id.md new file mode 100644 index 000000000..cecec2a38 --- /dev/null +++ b/api/xstate/xstate.statenode.id.md @@ -0,0 +1,20 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.id property + +The unique ID of the state node. + +**Signature:** + +```typescript +id: string; +``` diff --git a/api/xstate/xstate.statenode.initial.md b/api/xstate/xstate.statenode.initial.md new file mode 100644 index 000000000..71ced021a --- /dev/null +++ b/api/xstate/xstate.statenode.initial.md @@ -0,0 +1,18 @@ +--- +title: "initial" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.initial property + +**Signature:** + +```typescript +get initial(): InitialTransitionDefinition; +``` diff --git a/api/xstate/xstate.statenode.invoke.md b/api/xstate/xstate.statenode.invoke.md new file mode 100644 index 000000000..d0555f18c --- /dev/null +++ b/api/xstate/xstate.statenode.invoke.md @@ -0,0 +1,20 @@ +--- +title: "invoke" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.invoke property + +The logic invoked as actors by this state node. + +**Signature:** + +```typescript +get invoke(): Array>; +``` diff --git a/api/xstate/xstate.statenode.key.md b/api/xstate/xstate.statenode.key.md new file mode 100644 index 000000000..61bc2605b --- /dev/null +++ b/api/xstate/xstate.statenode.key.md @@ -0,0 +1,20 @@ +--- +title: "key" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.key property + +The relative key of the state node, which represents its location in the overall state value. + +**Signature:** + +```typescript +key: string; +``` diff --git a/api/xstate/xstate.statenode.machine.md b/api/xstate/xstate.statenode.machine.md new file mode 100644 index 000000000..f3bfa4088 --- /dev/null +++ b/api/xstate/xstate.statenode.machine.md @@ -0,0 +1,26 @@ +--- +title: "machine" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.machine property + +The root machine node. + +**Signature:** + +```typescript +machine: StateMachine; +``` diff --git a/api/xstate/xstate.statenode.md b/api/xstate/xstate.statenode.md new file mode 100644 index 000000000..f5f6f2a85 --- /dev/null +++ b/api/xstate/xstate.statenode.md @@ -0,0 +1,63 @@ +--- +title: "StateNode" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode class + +**Signature:** + +```typescript +export declare class StateNode +``` + +## Constructors + +| Constructor | Modifiers | Description | +| --- | --- | --- | +| [(constructor)(config, options)](./xstate.statenode._constructor_.md) | | Constructs a new instance of the StateNode class | + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [after](./xstate.statenode.after.md) | readonly | Array<[DelayedTransitionDefinition](./xstate.delayedtransitiondefinition.md)<><TContext, TEvent>> | | +| [always?](./xstate.statenode.always.md) | | Array<[TransitionDefinition](./xstate.transitiondefinition.md)<><TContext, TEvent>> | _(Optional)_ | +| [config](./xstate.statenode.config.md) | | [StateNodeConfig](./xstate.statenodeconfig.md)<><TContext, TEvent, [TODO](./xstate.todo.md)<>, // actions [TODO](./xstate.todo.md)<>, // actors [TODO](./xstate.todo.md)<>, // output [TODO](./xstate.todo.md)<>, // guards [TODO](./xstate.todo.md)<>, // delays [TODO](./xstate.todo.md)<>> | The raw config used to create the machine. | +| [definition](./xstate.statenode.definition.md) | readonly | [StateNodeDefinition](./xstate.statenodedefinition.md)<><TContext, TEvent> | The well-structured state node definition. | +| [description?](./xstate.statenode.description.md) | | string | _(Optional)_ | +| [entry](./xstate.statenode.entry.md) | | [UnknownAction](./xstate.unknownaction.md)<>\[\] | The action(s) to be executed upon entering the state node. | +| [events](./xstate.statenode.events.md) | readonly | Array<TEvent\['type'\]> | All the event types accepted by this state node and its descendants. | +| [exit](./xstate.statenode.exit.md) | | [UnknownAction](./xstate.unknownaction.md)<>\[\] | The action(s) to be executed upon exiting the state node. | +| [history](./xstate.statenode.history.md) | | false \| 'shallow' \| 'deep' |

The type of history on this state node. Can be:

- 'shallow' - recalls only top-level historical state value - 'deep' - recalls historical state value at all levels

| +| [id](./xstate.statenode.id.md) | | string | The unique ID of the state node. | +| [initial](./xstate.statenode.initial.md) | readonly | [InitialTransitionDefinition](./xstate.initialtransitiondefinition.md)<><TContext, TEvent> | | +| [invoke](./xstate.statenode.invoke.md) | readonly | Array<[InvokeDefinition](./xstate.invokedefinition.md)<><TContext, TEvent, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, string>> | The logic invoked as actors by this state node. | +| [key](./xstate.statenode.key.md) | | string | The relative key of the state node, which represents its location in the overall state value. | +| [machine](./xstate.statenode.machine.md) | | [StateMachine](./xstate.statemachine.md)<><TContext, TEvent, any, // actors any, // input [TODO](./xstate.todo.md)<>, // output [TODO](./xstate.todo.md)<>, // guards [TODO](./xstate.todo.md)<>, // delays [TODO](./xstate.todo.md)<>, // tags [TODO](./xstate.todo.md)<>> | The root machine node. | +| [meta?](./xstate.statenode.meta.md) | | any | _(Optional)_ The meta data associated with this state node, which will be returned in State instances. | +| [on](./xstate.statenode.on.md) | readonly | [TransitionDefinitionMap](./xstate.transitiondefinitionmap.md)<><TContext, TEvent> | The mapping of events to transitions. | +| [order](./xstate.statenode.order.md) | | number | The order this state node appears. Corresponds to the implicit document order. | +| [output?](./xstate.statenode.output.md) | | [Mapper](./xstate.mapper.md)<><[MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, unknown, [EventObject](./xstate.eventobject.md)<>> \| [NonReducibleUnknown](./xstate.nonreducibleunknown.md) | _(Optional)_ The output data sent with the "xstate.done.state.\_id\_" event if this is a final state node. | +| [ownEvents](./xstate.statenode.ownevents.md) | readonly | Array<TEvent\['type'\]> |

All the events that have transitions directly from this state node.

Excludes any inert events.

| +| [parent?](./xstate.statenode.parent.md) | | [StateNode](./xstate.statenode.md)<><TContext, TEvent> | _(Optional)_ The parent state node. | +| [path](./xstate.statenode.path.md) | | string\[\] | The string path from the root machine node to this node. | +| [states](./xstate.statenode.states.md) | | [StateNodesConfig](./xstate.statenodesconfig.md)<><TContext, TEvent> | The child state nodes. | +| [tags](./xstate.statenode.tags.md) | | string\[\] | | +| [transitions](./xstate.statenode.transitions.md) | | Map<string, [TransitionDefinition](./xstate.transitiondefinition.md)<><TContext, TEvent>\[\]> | | +| [type](./xstate.statenode.type.md) | | 'atomic' \| 'compound' \| 'parallel' \| 'final' \| 'history' |

The type of this state node:

- 'atomic' - no child state nodes - 'compound' - nested child state nodes (XOR) - 'parallel' - orthogonal nested child state nodes (AND) - 'history' - history state node - 'final' - final state node

| + +## Methods + +| Method | Modifiers | Description | +| --- | --- | --- | +| [\_initialize()](./xstate.statenode._initialize.md) | | | +| [next(state, event)](./xstate.statenode.next.md) | | | +| [toJSON()](./xstate.statenode.tojson.md) | | | + diff --git a/api/xstate/xstate.statenode.meta.md b/api/xstate/xstate.statenode.meta.md new file mode 100644 index 000000000..ffabf6c92 --- /dev/null +++ b/api/xstate/xstate.statenode.meta.md @@ -0,0 +1,20 @@ +--- +title: "meta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.meta property + +The meta data associated with this state node, which will be returned in State instances. + +**Signature:** + +```typescript +meta?: any; +``` diff --git a/api/xstate/xstate.statenode.next.md b/api/xstate/xstate.statenode.next.md new file mode 100644 index 000000000..e374379dc --- /dev/null +++ b/api/xstate/xstate.statenode.next.md @@ -0,0 +1,30 @@ +--- +title: "next" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.next() method + +**Signature:** + +```typescript +next(state: State, event: TEvent): TransitionDefinition[] | undefined; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| state | [State](./xstate.state.md)<><TContext, TEvent, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>> | | +| event | TEvent | | + +**Returns:** + +[TransitionDefinition](./xstate.transitiondefinition.md)<><TContext, TEvent>\[\] \| undefined + diff --git a/api/xstate/xstate.statenode.on.md b/api/xstate/xstate.statenode.on.md new file mode 100644 index 000000000..48d6ac629 --- /dev/null +++ b/api/xstate/xstate.statenode.on.md @@ -0,0 +1,20 @@ +--- +title: "on" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.on property + +The mapping of events to transitions. + +**Signature:** + +```typescript +get on(): TransitionDefinitionMap; +``` diff --git a/api/xstate/xstate.statenode.order.md b/api/xstate/xstate.statenode.order.md new file mode 100644 index 000000000..163d217cb --- /dev/null +++ b/api/xstate/xstate.statenode.order.md @@ -0,0 +1,20 @@ +--- +title: "order" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.order property + +The order this state node appears. Corresponds to the implicit document order. + +**Signature:** + +```typescript +order: number; +``` diff --git a/api/xstate/xstate.statenode.output.md b/api/xstate/xstate.statenode.output.md new file mode 100644 index 000000000..4892c784c --- /dev/null +++ b/api/xstate/xstate.statenode.output.md @@ -0,0 +1,20 @@ +--- +title: "output" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.output property + +The output data sent with the "xstate.done.state.\_id\_" event if this is a final state node. + +**Signature:** + +```typescript +output?: Mapper | NonReducibleUnknown; +``` diff --git a/api/xstate/xstate.statenode.ownevents.md b/api/xstate/xstate.statenode.ownevents.md new file mode 100644 index 000000000..042df62c5 --- /dev/null +++ b/api/xstate/xstate.statenode.ownevents.md @@ -0,0 +1,22 @@ +--- +title: "ownEvents" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.ownEvents property + +All the events that have transitions directly from this state node. + +Excludes any inert events. + +**Signature:** + +```typescript +get ownEvents(): Array; +``` diff --git a/api/xstate/xstate.statenode.parent.md b/api/xstate/xstate.statenode.parent.md new file mode 100644 index 000000000..7060092e7 --- /dev/null +++ b/api/xstate/xstate.statenode.parent.md @@ -0,0 +1,20 @@ +--- +title: "parent" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.parent property + +The parent state node. + +**Signature:** + +```typescript +parent?: StateNode; +``` diff --git a/api/xstate/xstate.statenode.path.md b/api/xstate/xstate.statenode.path.md new file mode 100644 index 000000000..1844147b3 --- /dev/null +++ b/api/xstate/xstate.statenode.path.md @@ -0,0 +1,20 @@ +--- +title: "path" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.path property + +The string path from the root machine node to this node. + +**Signature:** + +```typescript +path: string[]; +``` diff --git a/api/xstate/xstate.statenode.states.md b/api/xstate/xstate.statenode.states.md new file mode 100644 index 000000000..0b46a2592 --- /dev/null +++ b/api/xstate/xstate.statenode.states.md @@ -0,0 +1,20 @@ +--- +title: "states" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.states property + +The child state nodes. + +**Signature:** + +```typescript +states: StateNodesConfig; +``` diff --git a/api/xstate/xstate.statenode.tags.md b/api/xstate/xstate.statenode.tags.md new file mode 100644 index 000000000..ba8b06784 --- /dev/null +++ b/api/xstate/xstate.statenode.tags.md @@ -0,0 +1,18 @@ +--- +title: "tags" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.tags property + +**Signature:** + +```typescript +tags: string[]; +``` diff --git a/api/xstate/xstate.statenode.tojson.md b/api/xstate/xstate.statenode.tojson.md new file mode 100644 index 000000000..86c36c5e9 --- /dev/null +++ b/api/xstate/xstate.statenode.tojson.md @@ -0,0 +1,22 @@ +--- +title: "toJSON" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.toJSON() method + +**Signature:** + +```typescript +toJSON(): StateNodeDefinition; +``` +**Returns:** + +[StateNodeDefinition](./xstate.statenodedefinition.md)<><TContext, TEvent> + diff --git a/api/xstate/xstate.statenode.transitions.md b/api/xstate/xstate.statenode.transitions.md new file mode 100644 index 000000000..4c4a949fc --- /dev/null +++ b/api/xstate/xstate.statenode.transitions.md @@ -0,0 +1,18 @@ +--- +title: "transitions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.transitions property + +**Signature:** + +```typescript +transitions: Map[]>; +``` diff --git a/api/xstate/xstate.statenode.type.md b/api/xstate/xstate.statenode.type.md new file mode 100644 index 000000000..307d4dee8 --- /dev/null +++ b/api/xstate/xstate.statenode.type.md @@ -0,0 +1,22 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNode.type property + +The type of this state node: + +- `'atomic'` - no child state nodes - `'compound'` - nested child state nodes (XOR) - `'parallel'` - orthogonal nested child state nodes (AND) - `'history'` - history state node - `'final'` - final state node + +**Signature:** + +```typescript +type: 'atomic' | 'compound' | 'parallel' | 'final' | 'history'; +``` diff --git a/api/xstate/xstate.statenodeconfig.after.md b/api/xstate/xstate.statenodeconfig.after.md new file mode 100644 index 000000000..e1c04416e --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.after.md @@ -0,0 +1,20 @@ +--- +title: "after" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.after property + +The mapping (or array) of delays (in milliseconds) to their potential transition(s). The delayed transitions are taken after the specified delay in an interpreter. + +**Signature:** + +```typescript +after?: DelayedTransitions; +``` diff --git a/api/xstate/xstate.statenodeconfig.always.md b/api/xstate/xstate.statenodeconfig.always.md new file mode 100644 index 000000000..f50e25910 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.always.md @@ -0,0 +1,20 @@ +--- +title: "always" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.always property + +An eventless transition that is always taken when this state node is active. + +**Signature:** + +```typescript +always?: TransitionConfigOrTarget; +``` diff --git a/api/xstate/xstate.statenodeconfig.description.md b/api/xstate/xstate.statenodeconfig.description.md new file mode 100644 index 000000000..9bc012424 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.description.md @@ -0,0 +1,20 @@ +--- +title: "description" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.description property + +A text description of the state node + +**Signature:** + +```typescript +description?: string; +``` diff --git a/api/xstate/xstate.statenodeconfig.entry.md b/api/xstate/xstate.statenodeconfig.entry.md new file mode 100644 index 000000000..461b9c5da --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.entry.md @@ -0,0 +1,20 @@ +--- +title: "entry" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.entry property + +The action(s) to be executed upon entering the state node. + +**Signature:** + +```typescript +entry?: Actions; +``` diff --git a/api/xstate/xstate.statenodeconfig.exit.md b/api/xstate/xstate.statenodeconfig.exit.md new file mode 100644 index 000000000..ff8f9163a --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.exit.md @@ -0,0 +1,20 @@ +--- +title: "exit" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.exit property + +The action(s) to be executed upon exiting the state node. + +**Signature:** + +```typescript +exit?: Actions; +``` diff --git a/api/xstate/xstate.statenodeconfig.history.md b/api/xstate/xstate.statenodeconfig.history.md new file mode 100644 index 000000000..d5fd5120b --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.history.md @@ -0,0 +1,20 @@ +--- +title: "history" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.history property + +Indicates whether the state node is a history state node, and what type of history: shallow, deep, true (shallow), false (none), undefined (none) + +**Signature:** + +```typescript +history?: 'shallow' | 'deep' | boolean | undefined; +``` diff --git a/api/xstate/xstate.statenodeconfig.id.md b/api/xstate/xstate.statenodeconfig.id.md new file mode 100644 index 000000000..a3df9ffd5 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.id.md @@ -0,0 +1,20 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.id property + +The unique ID of the state node, which can be referenced as a transition target via the `#id` syntax. + +**Signature:** + +```typescript +id?: string | undefined; +``` diff --git a/api/xstate/xstate.statenodeconfig.initial.md b/api/xstate/xstate.statenodeconfig.initial.md new file mode 100644 index 000000000..f0b414490 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.initial.md @@ -0,0 +1,20 @@ +--- +title: "initial" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.initial property + +The initial state transition. + +**Signature:** + +```typescript +initial?: InitialTransitionConfig | string | undefined; +``` diff --git a/api/xstate/xstate.statenodeconfig.invoke.md b/api/xstate/xstate.statenodeconfig.invoke.md new file mode 100644 index 000000000..a8bffe931 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.invoke.md @@ -0,0 +1,20 @@ +--- +title: "invoke" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.invoke property + +The services to invoke upon entering this state node. These services will be stopped upon exiting this state node. + +**Signature:** + +```typescript +invoke?: SingleOrArray>; +``` diff --git a/api/xstate/xstate.statenodeconfig.md b/api/xstate/xstate.statenodeconfig.md new file mode 100644 index 000000000..1ee1e4997 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.md @@ -0,0 +1,42 @@ +--- +title: "StateNodeConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig interface + +**Signature:** + +```typescript +export interface StateNodeConfig +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [after?](./xstate.statenodeconfig.after.md) | | [DelayedTransitions](./xstate.delayedtransitions.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay> | _(Optional)_ The mapping (or array) of delays (in milliseconds) to their potential transition(s). The delayed transitions are taken after the specified delay in an interpreter. | +| [always?](./xstate.statenodeconfig.always.md) | | [TransitionConfigOrTarget](./xstate.transitionconfigortarget.md)<><TContext, TEvent, TEvent, TActor, TAction, TGuard, TDelay> | _(Optional)_ An eventless transition that is always taken when this state node is active. | +| [description?](./xstate.statenodeconfig.description.md) | | string | _(Optional)_ A text description of the state node | +| [entry?](./xstate.statenodeconfig.entry.md) | | [Actions](./xstate.actions.md)<><TContext, TEvent, TEvent, undefined, TActor, TAction, TGuard, TDelay> | _(Optional)_ The action(s) to be executed upon entering the state node. | +| [exit?](./xstate.statenodeconfig.exit.md) | | [Actions](./xstate.actions.md)<><TContext, TEvent, TEvent, undefined, TActor, TAction, TGuard, TDelay> | _(Optional)_ The action(s) to be executed upon exiting the state node. | +| [history?](./xstate.statenodeconfig.history.md) | | 'shallow' \| 'deep' \| boolean \| undefined | _(Optional)_ Indicates whether the state node is a history state node, and what type of history: shallow, deep, true (shallow), false (none), undefined (none) | +| [id?](./xstate.statenodeconfig.id.md) | | string \| undefined | _(Optional)_ The unique ID of the state node, which can be referenced as a transition target via the #id syntax. | +| [initial?](./xstate.statenodeconfig.initial.md) | | [InitialTransitionConfig](./xstate.initialtransitionconfig.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay> \| string \| undefined | _(Optional)_ The initial state transition. | +| [invoke?](./xstate.statenodeconfig.invoke.md) | | [SingleOrArray](./xstate.singleorarray.md)<><[InvokeConfig](./xstate.invokeconfig.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay>> | _(Optional)_ The services to invoke upon entering this state node. These services will be stopped upon exiting this state node. | +| [meta?](./xstate.statenodeconfig.meta.md) | | any | _(Optional)_ The meta data associated with this state node, which will be returned in State instances. | +| [on?](./xstate.statenodeconfig.on.md) | | [TransitionsConfig](./xstate.transitionsconfig.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay> | _(Optional)_ The mapping of event types to their potential transition(s). | +| [onDone?](./xstate.statenodeconfig.ondone.md) | | string \| [SingleOrArray](./xstate.singleorarray.md)<><[TransitionConfig](./xstate.transitionconfig.md)<><TContext, [DoneStateEvent](./xstate.donestateevent.md)<>, TEvent, TActor, TAction, TGuard, TDelay>> \| undefined |

_(Optional)_ The potential transition(s) to be taken upon reaching a final child state node.

This is equivalent to defining a [done(id)] transition on this state node's on property.

| +| [order?](./xstate.statenodeconfig.order.md) | | number | _(Optional)_ The order this state node appears. Corresponds to the implicit document order. | +| [output?](./xstate.statenodeconfig.output.md) | | [Mapper](./xstate.mapper.md)<><TContext, TEvent, unknown, TEvent> \| [NonReducibleUnknown](./xstate.nonreducibleunknown.md) |

_(Optional)_ The output data sent with the "xstate.done.state.\_id\_" event if this is a final state node.

The output data will be evaluated with the current context and placed on the .data property of the event.

| +| [states?](./xstate.statenodeconfig.states.md) | | [StatesConfig](./xstate.statesconfig.md)<><TContext, TEvent, TActor, TAction, TGuard, TDelay, TTag, [NonReducibleUnknown](./xstate.nonreducibleunknown.md)<>> \| undefined | _(Optional)_ The mapping of state node keys to their state node configurations (recursive). | +| [tags?](./xstate.statenodeconfig.tags.md) | | [SingleOrArray](./xstate.singleorarray.md)<><TTag> | _(Optional)_ The tags for this state node, which are accumulated into the state.tags property. | +| [target?](./xstate.statenodeconfig.target.md) | | string | _(Optional)_ A default target for a history state | +| [type?](./xstate.statenodeconfig.type.md) | | 'atomic' \| 'compound' \| 'parallel' \| 'final' \| 'history' |

_(Optional)_ The type of this state node:

- 'atomic' - no child state nodes - 'compound' - nested child state nodes (XOR) - 'parallel' - orthogonal nested child state nodes (AND) - 'history' - history state node - 'final' - final state node

| + diff --git a/api/xstate/xstate.statenodeconfig.meta.md b/api/xstate/xstate.statenodeconfig.meta.md new file mode 100644 index 000000000..d67515771 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.meta.md @@ -0,0 +1,20 @@ +--- +title: "meta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.meta property + +The meta data associated with this state node, which will be returned in State instances. + +**Signature:** + +```typescript +meta?: any; +``` diff --git a/api/xstate/xstate.statenodeconfig.on.md b/api/xstate/xstate.statenodeconfig.on.md new file mode 100644 index 000000000..f3663549a --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.on.md @@ -0,0 +1,20 @@ +--- +title: "on" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.on property + +The mapping of event types to their potential transition(s). + +**Signature:** + +```typescript +on?: TransitionsConfig; +``` diff --git a/api/xstate/xstate.statenodeconfig.ondone.md b/api/xstate/xstate.statenodeconfig.ondone.md new file mode 100644 index 000000000..b2a28bdc3 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.ondone.md @@ -0,0 +1,22 @@ +--- +title: "onDone" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.onDone property + +The potential transition(s) to be taken upon reaching a final child state node. + +This is equivalent to defining a `[done(id)]` transition on this state node's `on` property. + +**Signature:** + +```typescript +onDone?: string | SingleOrArray> | undefined; +``` diff --git a/api/xstate/xstate.statenodeconfig.order.md b/api/xstate/xstate.statenodeconfig.order.md new file mode 100644 index 000000000..d030ac55a --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.order.md @@ -0,0 +1,20 @@ +--- +title: "order" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.order property + +The order this state node appears. Corresponds to the implicit document order. + +**Signature:** + +```typescript +order?: number; +``` diff --git a/api/xstate/xstate.statenodeconfig.output.md b/api/xstate/xstate.statenodeconfig.output.md new file mode 100644 index 000000000..c3463addb --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.output.md @@ -0,0 +1,22 @@ +--- +title: "output" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.output property + +The output data sent with the "xstate.done.state.\_id\_" event if this is a final state node. + +The output data will be evaluated with the current `context` and placed on the `.data` property of the event. + +**Signature:** + +```typescript +output?: Mapper | NonReducibleUnknown; +``` diff --git a/api/xstate/xstate.statenodeconfig.states.md b/api/xstate/xstate.statenodeconfig.states.md new file mode 100644 index 000000000..52af973d6 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.states.md @@ -0,0 +1,20 @@ +--- +title: "states" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.states property + +The mapping of state node keys to their state node configurations (recursive). + +**Signature:** + +```typescript +states?: StatesConfig | undefined; +``` diff --git a/api/xstate/xstate.statenodeconfig.tags.md b/api/xstate/xstate.statenodeconfig.tags.md new file mode 100644 index 000000000..cfa14178f --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.tags.md @@ -0,0 +1,20 @@ +--- +title: "tags" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.tags property + +The tags for this state node, which are accumulated into the `state.tags` property. + +**Signature:** + +```typescript +tags?: SingleOrArray; +``` diff --git a/api/xstate/xstate.statenodeconfig.target.md b/api/xstate/xstate.statenodeconfig.target.md new file mode 100644 index 000000000..371f2265d --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.target.md @@ -0,0 +1,20 @@ +--- +title: "target" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.target property + +A default target for a history state + +**Signature:** + +```typescript +target?: string; +``` diff --git a/api/xstate/xstate.statenodeconfig.type.md b/api/xstate/xstate.statenodeconfig.type.md new file mode 100644 index 000000000..172721112 --- /dev/null +++ b/api/xstate/xstate.statenodeconfig.type.md @@ -0,0 +1,22 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeConfig.type property + +The type of this state node: + +- `'atomic'` - no child state nodes - `'compound'` - nested child state nodes (XOR) - `'parallel'` - orthogonal nested child state nodes (AND) - `'history'` - history state node - `'final'` - final state node + +**Signature:** + +```typescript +type?: 'atomic' | 'compound' | 'parallel' | 'final' | 'history'; +``` diff --git a/api/xstate/xstate.statenodedefinition.description.md b/api/xstate/xstate.statenodedefinition.description.md new file mode 100644 index 000000000..92edaf14d --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.description.md @@ -0,0 +1,18 @@ +--- +title: "description" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.description property + +**Signature:** + +```typescript +description?: string; +``` diff --git a/api/xstate/xstate.statenodedefinition.entry.md b/api/xstate/xstate.statenodedefinition.entry.md new file mode 100644 index 000000000..ddd4fa9cb --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.entry.md @@ -0,0 +1,18 @@ +--- +title: "entry" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.entry property + +**Signature:** + +```typescript +entry: UnknownAction[]; +``` diff --git a/api/xstate/xstate.statenodedefinition.exit.md b/api/xstate/xstate.statenodedefinition.exit.md new file mode 100644 index 000000000..0461dda29 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.exit.md @@ -0,0 +1,18 @@ +--- +title: "exit" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.exit property + +**Signature:** + +```typescript +exit: UnknownAction[]; +``` diff --git a/api/xstate/xstate.statenodedefinition.history.md b/api/xstate/xstate.statenodedefinition.history.md new file mode 100644 index 000000000..c31f892e7 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.history.md @@ -0,0 +1,18 @@ +--- +title: "history" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.history property + +**Signature:** + +```typescript +history: boolean | 'shallow' | 'deep' | undefined; +``` diff --git a/api/xstate/xstate.statenodedefinition.id.md b/api/xstate/xstate.statenodedefinition.id.md new file mode 100644 index 000000000..42ee43435 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.id.md @@ -0,0 +1,18 @@ +--- +title: "id" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.id property + +**Signature:** + +```typescript +id: string; +``` diff --git a/api/xstate/xstate.statenodedefinition.initial.md b/api/xstate/xstate.statenodedefinition.initial.md new file mode 100644 index 000000000..8a934e713 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.initial.md @@ -0,0 +1,18 @@ +--- +title: "initial" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.initial property + +**Signature:** + +```typescript +initial: InitialTransitionDefinition | undefined; +``` diff --git a/api/xstate/xstate.statenodedefinition.invoke.md b/api/xstate/xstate.statenodedefinition.invoke.md new file mode 100644 index 000000000..6e9c2cce5 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.invoke.md @@ -0,0 +1,18 @@ +--- +title: "invoke" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.invoke property + +**Signature:** + +```typescript +invoke: Array>; +``` diff --git a/api/xstate/xstate.statenodedefinition.key.md b/api/xstate/xstate.statenodedefinition.key.md new file mode 100644 index 000000000..23abbca82 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.key.md @@ -0,0 +1,18 @@ +--- +title: "key" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.key property + +**Signature:** + +```typescript +key: string; +``` diff --git a/api/xstate/xstate.statenodedefinition.md b/api/xstate/xstate.statenodedefinition.md new file mode 100644 index 000000000..4b4cf8c0d --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.md @@ -0,0 +1,41 @@ +--- +title: "StateNodeDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition interface + +**Signature:** + +```typescript +export interface StateNodeDefinition +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [description?](./xstate.statenodedefinition.description.md) | | string | _(Optional)_ | +| [entry](./xstate.statenodedefinition.entry.md) | | [UnknownAction](./xstate.unknownaction.md)<>\[\] | | +| [exit](./xstate.statenodedefinition.exit.md) | | [UnknownAction](./xstate.unknownaction.md)<>\[\] | | +| [history](./xstate.statenodedefinition.history.md) | | boolean \| 'shallow' \| 'deep' \| undefined | | +| [id](./xstate.statenodedefinition.id.md) | | string | | +| [initial](./xstate.statenodedefinition.initial.md) | | [InitialTransitionDefinition](./xstate.initialtransitiondefinition.md)<><TContext, TEvent> \| undefined | | +| [invoke](./xstate.statenodedefinition.invoke.md) | | Array<[InvokeDefinition](./xstate.invokedefinition.md)<><TContext, TEvent, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>>> | | +| [key](./xstate.statenodedefinition.key.md) | | string | | +| [meta](./xstate.statenodedefinition.meta.md) | | any | | +| [on](./xstate.statenodedefinition.on.md) | | [TransitionDefinitionMap](./xstate.transitiondefinitionmap.md)<><TContext, TEvent> | | +| [order](./xstate.statenodedefinition.order.md) | | number | | +| [output?](./xstate.statenodedefinition.output.md) | | [StateNodeConfig](./xstate.statenodeconfig.md)<><TContext, TEvent, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, string, string, unknown>\['output'\] | _(Optional)_ | +| [states](./xstate.statenodedefinition.states.md) | | [StatesDefinition](./xstate.statesdefinition.md)<><TContext, TEvent> | | +| [tags](./xstate.statenodedefinition.tags.md) | | string\[\] | | +| [transitions](./xstate.statenodedefinition.transitions.md) | | Array<[TransitionDefinition](./xstate.transitiondefinition.md)<><TContext, TEvent>> | | +| [type](./xstate.statenodedefinition.type.md) | | 'atomic' \| 'compound' \| 'parallel' \| 'final' \| 'history' | | +| [version?](./xstate.statenodedefinition.version.md) | | string \| undefined | _(Optional)_ | + diff --git a/api/xstate/xstate.statenodedefinition.meta.md b/api/xstate/xstate.statenodedefinition.meta.md new file mode 100644 index 000000000..ec43443ca --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.meta.md @@ -0,0 +1,18 @@ +--- +title: "meta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.meta property + +**Signature:** + +```typescript +meta: any; +``` diff --git a/api/xstate/xstate.statenodedefinition.on.md b/api/xstate/xstate.statenodedefinition.on.md new file mode 100644 index 000000000..273bf08bc --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.on.md @@ -0,0 +1,18 @@ +--- +title: "on" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.on property + +**Signature:** + +```typescript +on: TransitionDefinitionMap; +``` diff --git a/api/xstate/xstate.statenodedefinition.order.md b/api/xstate/xstate.statenodedefinition.order.md new file mode 100644 index 000000000..39565abf1 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.order.md @@ -0,0 +1,18 @@ +--- +title: "order" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.order property + +**Signature:** + +```typescript +order: number; +``` diff --git a/api/xstate/xstate.statenodedefinition.output.md b/api/xstate/xstate.statenodedefinition.output.md new file mode 100644 index 000000000..ba3bbfe53 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.output.md @@ -0,0 +1,18 @@ +--- +title: "output" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.output property + +**Signature:** + +```typescript +output?: StateNodeConfig['output']; +``` diff --git a/api/xstate/xstate.statenodedefinition.states.md b/api/xstate/xstate.statenodedefinition.states.md new file mode 100644 index 000000000..c06eeb4e4 --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.states.md @@ -0,0 +1,18 @@ +--- +title: "states" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.states property + +**Signature:** + +```typescript +states: StatesDefinition; +``` diff --git a/api/xstate/xstate.statenodedefinition.tags.md b/api/xstate/xstate.statenodedefinition.tags.md new file mode 100644 index 000000000..99c72290c --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.tags.md @@ -0,0 +1,18 @@ +--- +title: "tags" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.tags property + +**Signature:** + +```typescript +tags: string[]; +``` diff --git a/api/xstate/xstate.statenodedefinition.transitions.md b/api/xstate/xstate.statenodedefinition.transitions.md new file mode 100644 index 000000000..75a7c880c --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.transitions.md @@ -0,0 +1,18 @@ +--- +title: "transitions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.transitions property + +**Signature:** + +```typescript +transitions: Array>; +``` diff --git a/api/xstate/xstate.statenodedefinition.type.md b/api/xstate/xstate.statenodedefinition.type.md new file mode 100644 index 000000000..f2ff0a1fa --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.type.md @@ -0,0 +1,18 @@ +--- +title: "type" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.type property + +**Signature:** + +```typescript +type: 'atomic' | 'compound' | 'parallel' | 'final' | 'history'; +``` diff --git a/api/xstate/xstate.statenodedefinition.version.md b/api/xstate/xstate.statenodedefinition.version.md new file mode 100644 index 000000000..a5ce7efed --- /dev/null +++ b/api/xstate/xstate.statenodedefinition.version.md @@ -0,0 +1,18 @@ +--- +title: "version" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodeDefinition.version property + +**Signature:** + +```typescript +version?: string | undefined; +``` diff --git a/api/xstate/xstate.statenodesconfig.md b/api/xstate/xstate.statenodesconfig.md new file mode 100644 index 000000000..fa5dc2293 --- /dev/null +++ b/api/xstate/xstate.statenodesconfig.md @@ -0,0 +1,22 @@ +--- +title: "StateNodesConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateNodesConfig type + +**Signature:** + +```typescript +export type StateNodesConfig = { + [K in string]: StateNode; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [StateNode](./xstate.statenode.md) + diff --git a/api/xstate/xstate.statesconfig.md b/api/xstate/xstate.statesconfig.md new file mode 100644 index 000000000..7452096ae --- /dev/null +++ b/api/xstate/xstate.statesconfig.md @@ -0,0 +1,22 @@ +--- +title: "StatesConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StatesConfig type + +**Signature:** + +```typescript +export type StatesConfig = { + [K in string]: StateNodeConfig; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [StateNodeConfig](./xstate.statenodeconfig.md) + diff --git a/api/xstate/xstate.statesdefinition.md b/api/xstate/xstate.statesdefinition.md new file mode 100644 index 000000000..6b6adffb3 --- /dev/null +++ b/api/xstate/xstate.statesdefinition.md @@ -0,0 +1,22 @@ +--- +title: "StatesDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StatesDefinition type + +**Signature:** + +```typescript +export type StatesDefinition = { + [K in string]: StateNodeDefinition; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [StateNodeDefinition](./xstate.statenodedefinition.md) + diff --git a/api/xstate/xstate.statetypes.md b/api/xstate/xstate.statetypes.md new file mode 100644 index 000000000..81978c259 --- /dev/null +++ b/api/xstate/xstate.statetypes.md @@ -0,0 +1,18 @@ +--- +title: "StateTypes" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateTypes type + +**Signature:** + +```typescript +export type StateTypes = 'atomic' | 'compound' | 'parallel' | 'final' | 'history' | string; +``` diff --git a/api/xstate/xstate.statevalue.md b/api/xstate/xstate.statevalue.md new file mode 100644 index 000000000..19575de0f --- /dev/null +++ b/api/xstate/xstate.statevalue.md @@ -0,0 +1,26 @@ +--- +title: "StateValue" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateValue type + +The string or object representing the state value relative to the parent state node. + +**Signature:** + +```typescript +export type StateValue = string | StateValueMap; +``` +**References:** [StateValueMap](./xstate.statevaluemap.md) + +## Remarks + +- For a child atomic state node, this is a string, e.g., `"pending"`<>. - For complex state nodes, this is an object, e.g., `{ success: "someChildState" }`<>. + diff --git a/api/xstate/xstate.statevaluefrom.md b/api/xstate/xstate.statevaluefrom.md new file mode 100644 index 000000000..eadeb894b --- /dev/null +++ b/api/xstate/xstate.statevaluefrom.md @@ -0,0 +1,20 @@ +--- +title: "StateValueFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateValueFrom type + +**Signature:** + +```typescript +export type StateValueFrom = Parameters['matches']>[0]; +``` +**References:** [AnyStateMachine](./xstate.anystatemachine.md)<>, [StateFrom](./xstate.statefrom.md) + diff --git a/api/xstate/xstate.statevaluemap.md b/api/xstate/xstate.statevaluemap.md new file mode 100644 index 000000000..07e96ab71 --- /dev/null +++ b/api/xstate/xstate.statevaluemap.md @@ -0,0 +1,18 @@ +--- +title: "StateValueMap" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StateValueMap interface + +**Signature:** + +```typescript +export interface StateValueMap +``` diff --git a/api/xstate/xstate.stop_2.md b/api/xstate/xstate.stop_2.md new file mode 100644 index 000000000..ba0b03214 --- /dev/null +++ b/api/xstate/xstate.stop_2.md @@ -0,0 +1,31 @@ +--- +title: "stop_2" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## stop\_2() function + +Stops an actor. + +**Signature:** + +```typescript +export declare function stop(actorRef: ResolvableActorRef): StopAction; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| actorRef | ResolvableActorRef<TContext, TExpressionEvent, TExpressionAction, TEvent> | The actor to stop. | + +**Returns:** + +[StopAction](./xstate.stopaction.md)<><TContext, TExpressionEvent, TExpressionAction, TEvent> + diff --git a/api/xstate/xstate.stopaction.md b/api/xstate/xstate.stopaction.md new file mode 100644 index 000000000..ff2868160 --- /dev/null +++ b/api/xstate/xstate.stopaction.md @@ -0,0 +1,18 @@ +--- +title: "StopAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## StopAction interface + +**Signature:** + +```typescript +export interface StopAction +``` diff --git a/api/xstate/xstate.subscribable.md b/api/xstate/xstate.subscribable.md new file mode 100644 index 000000000..5c067295e --- /dev/null +++ b/api/xstate/xstate.subscribable.md @@ -0,0 +1,27 @@ +--- +title: "Subscribable" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Subscribable interface + +**Signature:** + +```typescript +export interface Subscribable extends InteropSubscribable +``` +**Extends:** [InteropSubscribable](./xstate.interopsubscribable.md)<><T> + +## Methods + +| Method | Description | +| --- | --- | +| [subscribe(observer)](./xstate.subscribable.subscribe.md) | | +| [subscribe(next, error, complete)](./xstate.subscribable.subscribe_1.md) | | + diff --git a/api/xstate/xstate.subscribable.subscribe.md b/api/xstate/xstate.subscribable.subscribe.md new file mode 100644 index 000000000..06a25c207 --- /dev/null +++ b/api/xstate/xstate.subscribable.subscribe.md @@ -0,0 +1,29 @@ +--- +title: "subscribe" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Subscribable.subscribe() method + +**Signature:** + +```typescript +subscribe(observer: Observer): Subscription; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| observer | [Observer](./xstate.observer.md)<><T> | | + +**Returns:** + +[Subscription](./xstate.subscription.md) + diff --git a/api/xstate/xstate.subscribable.subscribe_1.md b/api/xstate/xstate.subscribable.subscribe_1.md new file mode 100644 index 000000000..b75262a65 --- /dev/null +++ b/api/xstate/xstate.subscribable.subscribe_1.md @@ -0,0 +1,31 @@ +--- +title: "subscribe" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Subscribable.subscribe() method + +**Signature:** + +```typescript +subscribe(next: (value: T) => void, error?: (error: any) => void, complete?: () => void): Subscription; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| next | (value: T) => void | | +| error | (error: any) => void | _(Optional)_ | +| complete | () => void | _(Optional)_ | + +**Returns:** + +[Subscription](./xstate.subscription.md) + diff --git a/api/xstate/xstate.subscription.md b/api/xstate/xstate.subscription.md new file mode 100644 index 000000000..1f494a0ed --- /dev/null +++ b/api/xstate/xstate.subscription.md @@ -0,0 +1,25 @@ +--- +title: "Subscription" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Subscription interface + +**Signature:** + +```typescript +export interface Subscription +``` + +## Methods + +| Method | Description | +| --- | --- | +| [unsubscribe()](./xstate.subscription.unsubscribe.md) | | + diff --git a/api/xstate/xstate.subscription.unsubscribe.md b/api/xstate/xstate.subscription.unsubscribe.md new file mode 100644 index 000000000..5b7888835 --- /dev/null +++ b/api/xstate/xstate.subscription.unsubscribe.md @@ -0,0 +1,22 @@ +--- +title: "unsubscribe" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Subscription.unsubscribe() method + +**Signature:** + +```typescript +unsubscribe(): void; +``` +**Returns:** + +void + diff --git a/api/xstate/xstate.tagsfrom.md b/api/xstate/xstate.tagsfrom.md new file mode 100644 index 000000000..c2a6487c3 --- /dev/null +++ b/api/xstate/xstate.tagsfrom.md @@ -0,0 +1,20 @@ +--- +title: "TagsFrom" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TagsFrom type + +**Signature:** + +```typescript +export type TagsFrom = Parameters['hasTag']>[0]; +``` +**References:** [AnyStateMachine](./xstate.anystatemachine.md)<>, [StateFrom](./xstate.statefrom.md) + diff --git a/api/xstate/xstate.todo.md b/api/xstate/xstate.todo.md new file mode 100644 index 000000000..725780354 --- /dev/null +++ b/api/xstate/xstate.todo.md @@ -0,0 +1,18 @@ +--- +title: "TODO" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TODO type + +**Signature:** + +```typescript +export type TODO = any; +``` diff --git a/api/xstate/xstate.toobserver.md b/api/xstate/xstate.toobserver.md new file mode 100644 index 000000000..b3f9306bc --- /dev/null +++ b/api/xstate/xstate.toobserver.md @@ -0,0 +1,31 @@ +--- +title: "toObserver" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## toObserver() function + +**Signature:** + +```typescript +export declare function toObserver(nextHandler?: Observer | ((value: T) => void), errorHandler?: (error: any) => void, completionHandler?: () => void): Observer; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| nextHandler | [Observer](./xstate.observer.md)<><T> \| ((value: T) => void) | _(Optional)_ | +| errorHandler | (error: any) => void | _(Optional)_ | +| completionHandler | () => void | _(Optional)_ | + +**Returns:** + +[Observer](./xstate.observer.md)<><T> + diff --git a/api/xstate/xstate.transitionactorlogic.md b/api/xstate/xstate.transitionactorlogic.md new file mode 100644 index 000000000..4c65cfdae --- /dev/null +++ b/api/xstate/xstate.transitionactorlogic.md @@ -0,0 +1,20 @@ +--- +title: "TransitionActorLogic" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionActorLogic type + +**Signature:** + +```typescript +export type TransitionActorLogic = ActorLogic, TEvent, TInput, TransitionSnapshot, AnyActorSystem>; +``` +**References:** [EventObject](./xstate.eventobject.md)<>, [ActorLogic](./xstate.actorlogic.md)<>, [TransitionSnapshot](./xstate.transitionsnapshot.md)<>, [AnyActorSystem](./xstate.anyactorsystem.md) + diff --git a/api/xstate/xstate.transitionconfig.actions.md b/api/xstate/xstate.transitionconfig.actions.md new file mode 100644 index 000000000..7ba059737 --- /dev/null +++ b/api/xstate/xstate.transitionconfig.actions.md @@ -0,0 +1,18 @@ +--- +title: "actions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfig.actions property + +**Signature:** + +```typescript +actions?: Actions; +``` diff --git a/api/xstate/xstate.transitionconfig.description.md b/api/xstate/xstate.transitionconfig.description.md new file mode 100644 index 000000000..d27dcc6ab --- /dev/null +++ b/api/xstate/xstate.transitionconfig.description.md @@ -0,0 +1,18 @@ +--- +title: "description" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfig.description property + +**Signature:** + +```typescript +description?: string; +``` diff --git a/api/xstate/xstate.transitionconfig.guard.md b/api/xstate/xstate.transitionconfig.guard.md new file mode 100644 index 000000000..240c44990 --- /dev/null +++ b/api/xstate/xstate.transitionconfig.guard.md @@ -0,0 +1,18 @@ +--- +title: "guard" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfig.guard property + +**Signature:** + +```typescript +guard?: Guard; +``` diff --git a/api/xstate/xstate.transitionconfig.md b/api/xstate/xstate.transitionconfig.md new file mode 100644 index 000000000..507a169f6 --- /dev/null +++ b/api/xstate/xstate.transitionconfig.md @@ -0,0 +1,30 @@ +--- +title: "TransitionConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfig interface + +**Signature:** + +```typescript +export interface TransitionConfig +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actions?](./xstate.transitionconfig.actions.md) | | [Actions](./xstate.actions.md)<><TContext, TExpressionEvent, TEvent, undefined, TActor, TAction, TGuard, TDelay> | _(Optional)_ | +| [description?](./xstate.transitionconfig.description.md) | | string | _(Optional)_ | +| [guard?](./xstate.transitionconfig.guard.md) | | Guard<TContext, TExpressionEvent, undefined, TGuard> | _(Optional)_ | +| [meta?](./xstate.transitionconfig.meta.md) | | Record<string, any> | _(Optional)_ | +| [reenter?](./xstate.transitionconfig.reenter.md) | | boolean | _(Optional)_ | +| [target?](./xstate.transitionconfig.target.md) | | [TransitionTarget](./xstate.transitiontarget.md) \| undefined | _(Optional)_ | + diff --git a/api/xstate/xstate.transitionconfig.meta.md b/api/xstate/xstate.transitionconfig.meta.md new file mode 100644 index 000000000..ab68aacb8 --- /dev/null +++ b/api/xstate/xstate.transitionconfig.meta.md @@ -0,0 +1,18 @@ +--- +title: "meta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfig.meta property + +**Signature:** + +```typescript +meta?: Record; +``` diff --git a/api/xstate/xstate.transitionconfig.reenter.md b/api/xstate/xstate.transitionconfig.reenter.md new file mode 100644 index 000000000..5a1b0966d --- /dev/null +++ b/api/xstate/xstate.transitionconfig.reenter.md @@ -0,0 +1,18 @@ +--- +title: "reenter" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfig.reenter property + +**Signature:** + +```typescript +reenter?: boolean; +``` diff --git a/api/xstate/xstate.transitionconfig.target.md b/api/xstate/xstate.transitionconfig.target.md new file mode 100644 index 000000000..b6f5b0348 --- /dev/null +++ b/api/xstate/xstate.transitionconfig.target.md @@ -0,0 +1,18 @@ +--- +title: "target" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfig.target property + +**Signature:** + +```typescript +target?: TransitionTarget | undefined; +``` diff --git a/api/xstate/xstate.transitionconfigortarget.md b/api/xstate/xstate.transitionconfigortarget.md new file mode 100644 index 000000000..806c26bdf --- /dev/null +++ b/api/xstate/xstate.transitionconfigortarget.md @@ -0,0 +1,20 @@ +--- +title: "TransitionConfigOrTarget" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfigOrTarget type + +**Signature:** + +```typescript +export type TransitionConfigOrTarget = SingleOrArray>; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [SingleOrArray](./xstate.singleorarray.md)<>, [TransitionConfigTarget](./xstate.transitionconfigtarget.md)<>, [TransitionConfig](./xstate.transitionconfig.md) + diff --git a/api/xstate/xstate.transitionconfigtarget.md b/api/xstate/xstate.transitionconfigtarget.md new file mode 100644 index 000000000..918333565 --- /dev/null +++ b/api/xstate/xstate.transitionconfigtarget.md @@ -0,0 +1,18 @@ +--- +title: "TransitionConfigTarget" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionConfigTarget type + +**Signature:** + +```typescript +export type TransitionConfigTarget = string | undefined; +``` diff --git a/api/xstate/xstate.transitiondefinition.actions.md b/api/xstate/xstate.transitiondefinition.actions.md new file mode 100644 index 000000000..5f7003132 --- /dev/null +++ b/api/xstate/xstate.transitiondefinition.actions.md @@ -0,0 +1,18 @@ +--- +title: "actions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinition.actions property + +**Signature:** + +```typescript +actions: readonly UnknownAction[]; +``` diff --git a/api/xstate/xstate.transitiondefinition.eventtype.md b/api/xstate/xstate.transitiondefinition.eventtype.md new file mode 100644 index 000000000..213cd8177 --- /dev/null +++ b/api/xstate/xstate.transitiondefinition.eventtype.md @@ -0,0 +1,18 @@ +--- +title: "eventType" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinition.eventType property + +**Signature:** + +```typescript +eventType: EventDescriptor; +``` diff --git a/api/xstate/xstate.transitiondefinition.guard.md b/api/xstate/xstate.transitiondefinition.guard.md new file mode 100644 index 000000000..915ce30d0 --- /dev/null +++ b/api/xstate/xstate.transitiondefinition.guard.md @@ -0,0 +1,18 @@ +--- +title: "guard" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinition.guard property + +**Signature:** + +```typescript +guard?: UnknownGuard; +``` diff --git a/api/xstate/xstate.transitiondefinition.md b/api/xstate/xstate.transitiondefinition.md new file mode 100644 index 000000000..9b2f3f6a5 --- /dev/null +++ b/api/xstate/xstate.transitiondefinition.md @@ -0,0 +1,32 @@ +--- +title: "TransitionDefinition" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinition interface + +**Signature:** + +```typescript +export interface TransitionDefinition extends Omit, 'target' | 'guard'> +``` +**Extends:** Omit<[TransitionConfig](./xstate.transitionconfig.md)<><TContext, TEvent, TEvent, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>, [TODO](./xstate.todo.md)<>>, 'target' \| 'guard'> + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [actions](./xstate.transitiondefinition.actions.md) | | readonly [UnknownAction](./xstate.unknownaction.md)<>\[\] | | +| [eventType](./xstate.transitiondefinition.eventtype.md) | | [EventDescriptor](./xstate.eventdescriptor.md)<><TEvent> | | +| [guard?](./xstate.transitiondefinition.guard.md) | | UnknownGuard | _(Optional)_ | +| [reenter](./xstate.transitiondefinition.reenter.md) | | boolean | | +| [source](./xstate.transitiondefinition.source.md) | | [StateNode](./xstate.statenode.md)<><TContext, TEvent> | | +| [target](./xstate.transitiondefinition.target.md) | | ReadonlyArray<[StateNode](./xstate.statenode.md)<><TContext, TEvent>> \| undefined | | +| [toJSON](./xstate.transitiondefinition.tojson.md) | | () => { target: string\[\] \| undefined; source: string; actions: readonly [UnknownAction](./xstate.unknownaction.md)<>\[\]; guard?: UnknownGuard; eventType: [EventDescriptor](./xstate.eventdescriptor.md)<><TEvent>; meta?: Record<string, any>; } | | + diff --git a/api/xstate/xstate.transitiondefinition.reenter.md b/api/xstate/xstate.transitiondefinition.reenter.md new file mode 100644 index 000000000..e81e488f1 --- /dev/null +++ b/api/xstate/xstate.transitiondefinition.reenter.md @@ -0,0 +1,18 @@ +--- +title: "reenter" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinition.reenter property + +**Signature:** + +```typescript +reenter: boolean; +``` diff --git a/api/xstate/xstate.transitiondefinition.source.md b/api/xstate/xstate.transitiondefinition.source.md new file mode 100644 index 000000000..f19311be6 --- /dev/null +++ b/api/xstate/xstate.transitiondefinition.source.md @@ -0,0 +1,18 @@ +--- +title: "source" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinition.source property + +**Signature:** + +```typescript +source: StateNode; +``` diff --git a/api/xstate/xstate.transitiondefinition.target.md b/api/xstate/xstate.transitiondefinition.target.md new file mode 100644 index 000000000..b7a592c69 --- /dev/null +++ b/api/xstate/xstate.transitiondefinition.target.md @@ -0,0 +1,18 @@ +--- +title: "target" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinition.target property + +**Signature:** + +```typescript +target: ReadonlyArray> | undefined; +``` diff --git a/api/xstate/xstate.transitiondefinition.tojson.md b/api/xstate/xstate.transitiondefinition.tojson.md new file mode 100644 index 000000000..3a2512ad8 --- /dev/null +++ b/api/xstate/xstate.transitiondefinition.tojson.md @@ -0,0 +1,25 @@ +--- +title: "toJSON" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinition.toJSON property + +**Signature:** + +```typescript +toJSON: () => { + target: string[] | undefined; + source: string; + actions: readonly UnknownAction[]; + guard?: UnknownGuard; + eventType: EventDescriptor; + meta?: Record; + }; +``` diff --git a/api/xstate/xstate.transitiondefinitionmap.md b/api/xstate/xstate.transitiondefinitionmap.md new file mode 100644 index 000000000..794175398 --- /dev/null +++ b/api/xstate/xstate.transitiondefinitionmap.md @@ -0,0 +1,22 @@ +--- +title: "TransitionDefinitionMap" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionDefinitionMap type + +**Signature:** + +```typescript +export type TransitionDefinitionMap = { + [K in EventDescriptor]: Array>>; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [EventDescriptor](./xstate.eventdescriptor.md)<>, [TransitionDefinition](./xstate.transitiondefinition.md)<>, [ExtractEvent](./xstate.extractevent.md) + diff --git a/api/xstate/xstate.transitions.md b/api/xstate/xstate.transitions.md new file mode 100644 index 000000000..c22434ec7 --- /dev/null +++ b/api/xstate/xstate.transitions.md @@ -0,0 +1,20 @@ +--- +title: "Transitions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Transitions type + +**Signature:** + +```typescript +export type Transitions = Array>; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [TransitionDefinition](./xstate.transitiondefinition.md) + diff --git a/api/xstate/xstate.transitionsconfig.md b/api/xstate/xstate.transitionsconfig.md new file mode 100644 index 000000000..b33b5b140 --- /dev/null +++ b/api/xstate/xstate.transitionsconfig.md @@ -0,0 +1,22 @@ +--- +title: "TransitionsConfig" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionsConfig type + +**Signature:** + +```typescript +export type TransitionsConfig = { + [K in EventDescriptor]?: TransitionConfigOrTarget, TEvent, TActor, TAction, TGuard, TDelay>; +}; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ProvidedActor](./xstate.providedactor.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [EventDescriptor](./xstate.eventdescriptor.md)<>, [TransitionConfigOrTarget](./xstate.transitionconfigortarget.md)<>, [ExtractEvent](./xstate.extractevent.md) + diff --git a/api/xstate/xstate.transitionsnapshot.md b/api/xstate/xstate.transitionsnapshot.md new file mode 100644 index 000000000..594c419d3 --- /dev/null +++ b/api/xstate/xstate.transitionsnapshot.md @@ -0,0 +1,22 @@ +--- +title: "TransitionSnapshot" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionSnapshot type + +**Signature:** + +```typescript +export type TransitionSnapshot = Snapshot & { + context: TContext; +}; +``` +**References:** [Snapshot](./xstate.snapshot.md) + diff --git a/api/xstate/xstate.transitiontarget.md b/api/xstate/xstate.transitiontarget.md new file mode 100644 index 000000000..db36c427f --- /dev/null +++ b/api/xstate/xstate.transitiontarget.md @@ -0,0 +1,20 @@ +--- +title: "TransitionTarget" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TransitionTarget type + +**Signature:** + +```typescript +export type TransitionTarget = SingleOrArray; +``` +**References:** [SingleOrArray](./xstate.singleorarray.md) + diff --git a/api/xstate/xstate.typegenconstraint.md b/api/xstate/xstate.typegenconstraint.md new file mode 100644 index 000000000..8f1396ab7 --- /dev/null +++ b/api/xstate/xstate.typegenconstraint.md @@ -0,0 +1,20 @@ +--- +title: "TypegenConstraint" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenConstraint type + +**Signature:** + +```typescript +export type TypegenConstraint = TypegenEnabled | TypegenDisabled; +``` +**References:** [TypegenEnabled](./xstate.typegenenabled.md)<>, [TypegenDisabled](./xstate.typegendisabled.md) + diff --git a/api/xstate/xstate.typegendisabled.___xstate_typegen_.md b/api/xstate/xstate.typegendisabled.___xstate_typegen_.md new file mode 100644 index 000000000..3780abd38 --- /dev/null +++ b/api/xstate/xstate.typegendisabled.___xstate_typegen_.md @@ -0,0 +1,18 @@ +--- +title: "\"@@xstate/typegen\"" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenDisabled."@@xstate/typegen" property + +**Signature:** + +```typescript +'@@xstate/typegen': false; +``` diff --git a/api/xstate/xstate.typegendisabled.md b/api/xstate/xstate.typegendisabled.md new file mode 100644 index 000000000..9a1f0d66c --- /dev/null +++ b/api/xstate/xstate.typegendisabled.md @@ -0,0 +1,25 @@ +--- +title: "TypegenDisabled" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenDisabled interface + +**Signature:** + +```typescript +export interface TypegenDisabled +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| ["@@xstate/typegen"](./xstate.typegendisabled.___xstate_typegen_.md) | | false | | + diff --git a/api/xstate/xstate.typegenenabled.___xstate_typegen_.md b/api/xstate/xstate.typegenenabled.___xstate_typegen_.md new file mode 100644 index 000000000..d9a33afc1 --- /dev/null +++ b/api/xstate/xstate.typegenenabled.___xstate_typegen_.md @@ -0,0 +1,18 @@ +--- +title: "\"@@xstate/typegen\"" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenEnabled."@@xstate/typegen" property + +**Signature:** + +```typescript +'@@xstate/typegen': true; +``` diff --git a/api/xstate/xstate.typegenenabled.md b/api/xstate/xstate.typegenenabled.md new file mode 100644 index 000000000..0ad1a2589 --- /dev/null +++ b/api/xstate/xstate.typegenenabled.md @@ -0,0 +1,25 @@ +--- +title: "TypegenEnabled" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenEnabled interface + +**Signature:** + +```typescript +export interface TypegenEnabled +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| ["@@xstate/typegen"](./xstate.typegenenabled.___xstate_typegen_.md) | | true | | + diff --git a/api/xstate/xstate.typegenmeta.eventscausingactions.md b/api/xstate/xstate.typegenmeta.eventscausingactions.md new file mode 100644 index 000000000..5c041f1e7 --- /dev/null +++ b/api/xstate/xstate.typegenmeta.eventscausingactions.md @@ -0,0 +1,22 @@ +--- +title: "eventsCausingActions" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.eventsCausingActions property + +Keeps track of which events lead to which actions. + +Key: 'EVENT\_NAME' Value: 'actionName' \| 'otherActionName' + +**Signature:** + +```typescript +eventsCausingActions: Record; +``` diff --git a/api/xstate/xstate.typegenmeta.eventscausingactors.md b/api/xstate/xstate.typegenmeta.eventscausingactors.md new file mode 100644 index 000000000..18fa798c9 --- /dev/null +++ b/api/xstate/xstate.typegenmeta.eventscausingactors.md @@ -0,0 +1,22 @@ +--- +title: "eventsCausingActors" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.eventsCausingActors property + +Keeps track of which events lead to which actors. + +Key: 'EVENT\_NAME' Value: 'actorName' \| 'otherActorName' + +**Signature:** + +```typescript +eventsCausingActors: Record; +``` diff --git a/api/xstate/xstate.typegenmeta.eventscausingdelays.md b/api/xstate/xstate.typegenmeta.eventscausingdelays.md new file mode 100644 index 000000000..84b9dd210 --- /dev/null +++ b/api/xstate/xstate.typegenmeta.eventscausingdelays.md @@ -0,0 +1,22 @@ +--- +title: "eventsCausingDelays" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.eventsCausingDelays property + +Keeps track of which events lead to which delays. + +Key: 'EVENT\_NAME' Value: 'delayName' \| 'otherDelayName' + +**Signature:** + +```typescript +eventsCausingDelays: Record; +``` diff --git a/api/xstate/xstate.typegenmeta.eventscausingguards.md b/api/xstate/xstate.typegenmeta.eventscausingguards.md new file mode 100644 index 000000000..1599892df --- /dev/null +++ b/api/xstate/xstate.typegenmeta.eventscausingguards.md @@ -0,0 +1,22 @@ +--- +title: "eventsCausingGuards" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.eventsCausingGuards property + +Keeps track of which events lead to which guards. + +Key: 'EVENT\_NAME' Value: 'guardName' \| 'otherGuardName' + +**Signature:** + +```typescript +eventsCausingGuards: Record; +``` diff --git a/api/xstate/xstate.typegenmeta.internalevents.md b/api/xstate/xstate.typegenmeta.internalevents.md new file mode 100644 index 000000000..edd1433d4 --- /dev/null +++ b/api/xstate/xstate.typegenmeta.internalevents.md @@ -0,0 +1,22 @@ +--- +title: "internalEvents" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.internalEvents property + +A map for the internal events of the machine. + +key: 'xstate.done.actor.myActor' value: { type: 'xstate.done.actor.myActor'; data: unknown; \_\_tip: 'Declare the type in event types!'; } + +**Signature:** + +```typescript +internalEvents: {}; +``` diff --git a/api/xstate/xstate.typegenmeta.invokesrcnamemap.md b/api/xstate/xstate.typegenmeta.invokesrcnamemap.md new file mode 100644 index 000000000..393d57b8c --- /dev/null +++ b/api/xstate/xstate.typegenmeta.invokesrcnamemap.md @@ -0,0 +1,22 @@ +--- +title: "invokeSrcNameMap" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.invokeSrcNameMap property + +Maps the src of the invoked actor to the event type that includes its known id + +key: 'invokeSrc' value: 'xstate.done.actor.invokeName' + +**Signature:** + +```typescript +invokeSrcNameMap: Record; +``` diff --git a/api/xstate/xstate.typegenmeta.matchesstates.md b/api/xstate/xstate.typegenmeta.matchesstates.md new file mode 100644 index 000000000..c6041e06e --- /dev/null +++ b/api/xstate/xstate.typegenmeta.matchesstates.md @@ -0,0 +1,20 @@ +--- +title: "matchesStates" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.matchesStates property + +Allows you to specify all the results of state.matches + +**Signature:** + +```typescript +matchesStates: string | {}; +``` diff --git a/api/xstate/xstate.typegenmeta.md b/api/xstate/xstate.typegenmeta.md new file mode 100644 index 000000000..af77828a1 --- /dev/null +++ b/api/xstate/xstate.typegenmeta.md @@ -0,0 +1,34 @@ +--- +title: "TypegenMeta" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta interface + +**Signature:** + +```typescript +export interface TypegenMeta extends TypegenEnabled +``` +**Extends:** [TypegenEnabled](./xstate.typegenenabled.md) + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [eventsCausingActions](./xstate.typegenmeta.eventscausingactions.md) | | Record<string, string> |

Keeps track of which events lead to which actions.

Key: 'EVENT\_NAME' Value: 'actionName' \| 'otherActionName'

| +| [eventsCausingActors](./xstate.typegenmeta.eventscausingactors.md) | | Record<string, string> |

Keeps track of which events lead to which actors.

Key: 'EVENT\_NAME' Value: 'actorName' \| 'otherActorName'

| +| [eventsCausingDelays](./xstate.typegenmeta.eventscausingdelays.md) | | Record<string, string> |

Keeps track of which events lead to which delays.

Key: 'EVENT\_NAME' Value: 'delayName' \| 'otherDelayName'

| +| [eventsCausingGuards](./xstate.typegenmeta.eventscausingguards.md) | | Record<string, string> |

Keeps track of which events lead to which guards.

Key: 'EVENT\_NAME' Value: 'guardName' \| 'otherGuardName'

| +| [internalEvents](./xstate.typegenmeta.internalevents.md) | | {} |

A map for the internal events of the machine.

key: 'xstate.done.actor.myActor' value: { type: 'xstate.done.actor.myActor'; data: unknown; \_\_tip: 'Declare the type in event types!'; }

| +| [invokeSrcNameMap](./xstate.typegenmeta.invokesrcnamemap.md) | | Record<string, string> |

Maps the src of the invoked actor to the event type that includes its known id

key: 'invokeSrc' value: 'xstate.done.actor.invokeName'

| +| [matchesStates](./xstate.typegenmeta.matchesstates.md) | | string \| {} | Allows you to specify all the results of state.matches | +| [missingImplementations](./xstate.typegenmeta.missingimplementations.md) | | { actions: string; actors: string; delays: string; guards: string; } | Allows you to specify all the missing implementations of the machine | +| [tags](./xstate.typegenmeta.tags.md) | | string | Allows you to specify all tags used by the machine | + diff --git a/api/xstate/xstate.typegenmeta.missingimplementations.md b/api/xstate/xstate.typegenmeta.missingimplementations.md new file mode 100644 index 000000000..f71654a0c --- /dev/null +++ b/api/xstate/xstate.typegenmeta.missingimplementations.md @@ -0,0 +1,25 @@ +--- +title: "missingImplementations" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.missingImplementations property + +Allows you to specify all the missing implementations of the machine + +**Signature:** + +```typescript +missingImplementations: { + actions: string; + actors: string; + delays: string; + guards: string; + }; +``` diff --git a/api/xstate/xstate.typegenmeta.tags.md b/api/xstate/xstate.typegenmeta.tags.md new file mode 100644 index 000000000..b016b57e8 --- /dev/null +++ b/api/xstate/xstate.typegenmeta.tags.md @@ -0,0 +1,20 @@ +--- +title: "tags" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## TypegenMeta.tags property + +Allows you to specify all tags used by the machine + +**Signature:** + +```typescript +tags: string; +``` diff --git a/api/xstate/xstate.unifiedarg.context.md b/api/xstate/xstate.unifiedarg.context.md new file mode 100644 index 000000000..ad314e1bd --- /dev/null +++ b/api/xstate/xstate.unifiedarg.context.md @@ -0,0 +1,18 @@ +--- +title: "context" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## UnifiedArg.context property + +**Signature:** + +```typescript +context: TContext; +``` diff --git a/api/xstate/xstate.unifiedarg.event.md b/api/xstate/xstate.unifiedarg.event.md new file mode 100644 index 000000000..18b4c80e1 --- /dev/null +++ b/api/xstate/xstate.unifiedarg.event.md @@ -0,0 +1,18 @@ +--- +title: "event" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## UnifiedArg.event property + +**Signature:** + +```typescript +event: TExpressionEvent; +``` diff --git a/api/xstate/xstate.unifiedarg.md b/api/xstate/xstate.unifiedarg.md new file mode 100644 index 000000000..ddd604eb8 --- /dev/null +++ b/api/xstate/xstate.unifiedarg.md @@ -0,0 +1,28 @@ +--- +title: "UnifiedArg" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## UnifiedArg interface + +**Signature:** + +```typescript +export interface UnifiedArg +``` + +## Properties + +| Property | Modifiers | Type | Description | +| --- | --- | --- | --- | +| [context](./xstate.unifiedarg.context.md) | | TContext | | +| [event](./xstate.unifiedarg.event.md) | | TExpressionEvent | | +| [self](./xstate.unifiedarg.self.md) | | [ActorRef](./xstate.actorref.md)<><TEvent, [MachineSnapshot](./xstate.machinesnapshot.md)<><TContext, TEvent, [ProvidedActor](./xstate.providedactor.md)<>, string, unknown>> | | +| [system](./xstate.unifiedarg.system.md) | | [ActorSystem](./xstate.actorsystem.md)<><any> | | + diff --git a/api/xstate/xstate.unifiedarg.self.md b/api/xstate/xstate.unifiedarg.self.md new file mode 100644 index 000000000..d45d39c8c --- /dev/null +++ b/api/xstate/xstate.unifiedarg.self.md @@ -0,0 +1,18 @@ +--- +title: "self" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## UnifiedArg.self property + +**Signature:** + +```typescript +self: ActorRef>; +``` diff --git a/api/xstate/xstate.unifiedarg.system.md b/api/xstate/xstate.unifiedarg.system.md new file mode 100644 index 000000000..c6227553a --- /dev/null +++ b/api/xstate/xstate.unifiedarg.system.md @@ -0,0 +1,18 @@ +--- +title: "system" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## UnifiedArg.system property + +**Signature:** + +```typescript +system: ActorSystem; +``` diff --git a/api/xstate/xstate.unknownaction.md b/api/xstate/xstate.unknownaction.md new file mode 100644 index 000000000..3dec202bf --- /dev/null +++ b/api/xstate/xstate.unknownaction.md @@ -0,0 +1,20 @@ +--- +title: "UnknownAction" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## UnknownAction type + +**Signature:** + +```typescript +export type UnknownAction = Action; +``` +**References:** [Action](./xstate.action.md)<>, [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md)<>, [ProvidedActor](./xstate.providedactor.md) + diff --git a/api/xstate/xstate.values.md b/api/xstate/xstate.values.md new file mode 100644 index 000000000..7cf8f6481 --- /dev/null +++ b/api/xstate/xstate.values.md @@ -0,0 +1,18 @@ +--- +title: "Values" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## Values type + +**Signature:** + +```typescript +export type Values = T[keyof T]; +``` diff --git a/api/xstate/xstate.waitfor.md b/api/xstate/xstate.waitfor.md new file mode 100644 index 000000000..16965a9f3 --- /dev/null +++ b/api/xstate/xstate.waitfor.md @@ -0,0 +1,46 @@ +--- +title: "waitFor" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## waitFor() function + +Subscribes to an actor ref and waits for its emitted value to satisfy a predicate, and then resolves with that value. Will throw if the desired state is not reached after a timeout (defaults to 10 seconds). + +**Signature:** + +```typescript +export declare function waitFor>(actorRef: TActorRef, predicate: (emitted: SnapshotFrom) => boolean, options?: Partial): Promise>; +``` + +## Parameters + +| Parameter | Type | Description | +| --- | --- | --- | +| actorRef | TActorRef | The actor ref to subscribe to | +| predicate | (emitted: [SnapshotFrom](./xstate.snapshotfrom.md)<><TActorRef>) => boolean | Determines if a value matches the condition to wait for | +| options | Partial<WaitForOptions> | _(Optional)_ | + +**Returns:** + +Promise<[SnapshotFrom](./xstate.snapshotfrom.md)<><TActorRef>> + +A promise that eventually resolves to the emitted value that matches the condition + +## Example + + +```js +const state = await waitFor(someService, state => { + return state.hasTag('loaded'); +}); + +state.hasTag('loaded'); // true +``` + diff --git a/api/xstate/xstate.withdynamicparams.md b/api/xstate/xstate.withdynamicparams.md new file mode 100644 index 000000000..e60971d41 --- /dev/null +++ b/api/xstate/xstate.withdynamicparams.md @@ -0,0 +1,26 @@ +--- +title: "WithDynamicParams" +hide_title: true +custom_edit_url: null +pagination_prev: null +pagination_next: null +--- + + + + +## WithDynamicParams type + +**Signature:** + +```typescript +export type WithDynamicParams = T extends any ? ConditionalRequired<{ + type: T['type']; + params?: T['params'] | (({ context, event }: { + context: TContext; + event: TExpressionEvent; + }) => T['params']); +}, undefined extends T['params'] ? false : true> : never; +``` +**References:** [MachineContext](./xstate.machinecontext.md)<>, [EventObject](./xstate.eventobject.md)<>, [ParameterizedObject](./xstate.parameterizedobject.md) +