From 210a6ed1f1e56596c85cce7d76a8ad75cb35c251 Mon Sep 17 00:00:00 2001 From: Romuald Oluwatobi Date: Tue, 29 Apr 2025 05:43:08 +0100 Subject: [PATCH 1/4] doc: fixing github doc links --- docs/api.md | 12 ++++++------ docs/configure.md | 4 ++-- docs/fire-event.md | 4 ++-- docs/introduction.md | 16 ++++++++-------- docs/queries.md | 6 +++--- docs/reference/classes/mutationobserver.md | 12 ++++++------ .../functions/bindobjectfnstoinstance.md | 2 +- docs/reference/functions/buildqueries.md | 2 +- docs/reference/functions/cleanup.md | 2 +- docs/reference/functions/configure.md | 2 +- docs/reference/functions/debounce.md | 2 +- docs/reference/functions/fireevent.md | 2 +- docs/reference/functions/getconfig.md | 2 +- docs/reference/functions/getcurrentinstance.md | 2 +- .../functions/getdefaultnormalizer.md | 2 +- docs/reference/functions/getinstanceerror.md | 2 +- .../functions/getqueriesforelement.md | 2 +- .../functions/jestfaketimersareenabled.md | 2 +- docs/reference/functions/makefindquery.md | 2 +- docs/reference/functions/makenormalizer.md | 2 +- docs/reference/functions/render.md | 2 +- docs/reference/functions/runobservers.md | 2 +- ...runwithexpensiveerrordiagnosticsdisabled.md | 2 +- docs/reference/functions/setcurrentinstance.md | 2 +- docs/reference/functions/waitfor.md | 2 +- .../functions/wrapsinglequerywithsuggestion.md | 2 +- docs/reference/interfaces/config.md | 16 ++++++++-------- docs/reference/interfaces/configfn.md | 4 ++-- .../interfaces/defaultnormalizeroptions.md | 8 ++++---- docs/reference/interfaces/keyboardkey.md | 6 +++--- docs/reference/interfaces/matcheroptions.md | 14 +++++++------- docs/reference/interfaces/normalizeroptions.md | 10 +++++----- docs/reference/interfaces/queries.md | 2 +- docs/reference/interfaces/renderoptions.md | 8 ++++---- .../interfaces/selectormatcheroptions.md | 18 +++++++++--------- docs/reference/interfaces/waitforoptions.md | 14 +++++++------- .../queries/functions/findbyerror.md | 2 +- .../namespaces/queries/functions/findbytext.md | 2 +- .../namespaces/queries/functions/getbyerror.md | 2 +- .../namespaces/queries/functions/getbytext.md | 2 +- .../queries/functions/querybyerror.md | 2 +- .../queries/functions/querybytext.md | 2 +- .../queries/type-aliases/findbyerror.md | 2 +- .../queries/type-aliases/findbytext.md | 2 +- .../queries/type-aliases/getbyerror.md | 2 +- .../queries/type-aliases/getbytext.md | 2 +- .../queries/type-aliases/querybyerror.md | 2 +- .../queries/type-aliases/querybytext.md | 2 +- docs/reference/type-aliases/boundfunction.md | 2 +- docs/reference/type-aliases/boundfunctions.md | 2 +- docs/reference/type-aliases/eventtype.md | 2 +- docs/reference/type-aliases/firefunction.md | 2 +- docs/reference/type-aliases/fireobject.md | 2 +- .../reference/type-aliases/geterrorfunction.md | 2 +- docs/reference/type-aliases/match.md | 2 +- docs/reference/type-aliases/matcher.md | 2 +- docs/reference/type-aliases/matcherfunction.md | 2 +- docs/reference/type-aliases/normalizerfn.md | 2 +- docs/reference/type-aliases/query.md | 2 +- docs/reference/type-aliases/querymethod.md | 2 +- docs/reference/type-aliases/renderresult.md | 2 +- docs/reference/type-aliases/withsuggest.md | 2 +- docs/user-event.md | 8 ++++---- 63 files changed, 127 insertions(+), 127 deletions(-) diff --git a/docs/api.md b/docs/api.md index 550a96f..c2e69a0 100644 --- a/docs/api.md +++ b/docs/api.md @@ -96,7 +96,7 @@ The most important feature of render is that the queries from [CLI Testing Library](https://github.com/crutchcorn/cli-testing-library) are automatically returned with their first argument bound to the testInstance. -See [Queries](./queries) to learn more about how to use these queries and the +See [Queries](./queries.md) to learn more about how to use these queries and the philosophy behind them. ### ByText @@ -122,7 +122,7 @@ Queries for test instance `stdout` results with the given text (and it also accepts a TextMatch). These options are all standard for text matching. To learn more, see our -[Queries page](./queries). +[Queries page](./queries.md). ## `userEvent[eventName]` @@ -132,11 +132,11 @@ userEvent[eventName](...eventProps) > While `userEvent` isn't usually returned on `render` in, say, > `React Testing Library`, we're able to do so because of our differences in -> implementation with upstream. See our [Differences](./differences) doc for +> implementation with upstream. See our [Differences](./differences.md) doc for > more. This object is the same as described with -[`userEvent` documentation](./user-event) with the key difference that +[`userEvent` documentation](./user-event.md) with the key difference that `instance` is not expected to be passed when bound to `render`. ## `debug` @@ -158,7 +158,7 @@ debug() ``` This is a simple wrapper around `prettyCLI` which is also exposed and comes from -[CLI Testing Library](./debug). +[CLI Testing Library](./debug.md). ## `hasExit` @@ -184,7 +184,7 @@ so you can call `process.pid` etc. to inspect the process. ## `stdoutArr`/`stderrArr` Each of these is an array of what's output by their respective `std`\* pipe. -This is used internally to create the [`debug`methods](./debug) and more. +This is used internally to create the [`debug`methods](./debug.md) and more. They're defined as: ```typescript diff --git a/docs/configure.md b/docs/configure.md index b798212..445496c 100644 --- a/docs/configure.md +++ b/docs/configure.md @@ -25,7 +25,7 @@ to `waitFor`. ### `throwSuggestions` (experimental) -When enabled, if [better queries](./queries) are available the test will fail +When enabled, if [better queries](./queries.md) are available the test will fail and provide a suggested query to use instead. Default to `false`. To disable a suggestion for a single query just add `{suggest:false}` as an @@ -51,7 +51,7 @@ to 1000ms. By default, we wait for the CLI to `spawn` the command from `render`. If we immediately resolve the promise to allow users to query, however, we lose the ability to `getByText` immediately after rendering. This -[differs greatly from upstream Testing Library](./differences) and makes for +[differs greatly from upstream Testing Library](./differences.md) and makes for a poor testing experience. As a result, we wait this duration before resolving the promise after the diff --git a/docs/fire-event.md b/docs/fire-event.md index edac334..5426312 100644 --- a/docs/fire-event.md +++ b/docs/fire-event.md @@ -5,7 +5,7 @@ title: "Firing Events" > **Note** > > Most projects have a few use cases for `fireEvent`, but the majority of the -> time you should probably use [`userEvent`](./user-event). +> time you should probably use [`userEvent`](./user-event.md). ## `fireEvent` @@ -26,5 +26,5 @@ fireEvent[eventName](instance: TestInstance, eventProperties?: Object) ``` Convenience methods for firing CLI events. Check out -[src/event-map.js](../src/event-map.ts) for a full list as well as default +[src/event-map.js](../packages/cli-testing-library/src/event-map.ts) for a full list as well as default `eventProperties`. diff --git a/docs/introduction.md b/docs/introduction.md index a876055..b6613e5 100644 --- a/docs/introduction.md +++ b/docs/introduction.md @@ -51,11 +51,11 @@ will work when a real user uses it. # Further Reading -- [API reference for `render` and friends](./api) -- [Jest and Vitest matchers](./matchers) -- [Mock user input](./user-event) -- [Manually fire input events](./fire-event) -- [Output matching queries](./queries) -- [Debugging "CLI Testing Library" tests](./debug) -- [Configure library options](./configure) -- [Differences between us and other "Testing Library" projects](./differences) +- [API reference for `render` and friends](./api.md) +- [Jest and Vitest matchers](./matchers.md) +- [Mock user input](./user-event.md) +- [Manually fire input events](./fire-event.md) +- [Output matching queries](./queries.md) +- [Debugging "CLI Testing Library" tests](./debug.md) +- [Configure library options](./configure.md) +- [Differences between us and other "Testing Library" projects](./differences.md) diff --git a/docs/queries.md b/docs/queries.md index e9a7a6b..2c2976a 100644 --- a/docs/queries.md +++ b/docs/queries.md @@ -9,7 +9,7 @@ if no CLI instance is found or if it will return a Promise and retry. Depending on what app content you are selecting, different queries may be more or less appropriate. -While our APIs [differ slightly](./differences) from upstream Testing +While our APIs [differ slightly](./differences.md) from upstream Testing Library's, [their "About Queries" page summarizes the goals and intentions of this project's queries quite well](https://testing-library.com/docs/queries/about/). @@ -176,7 +176,7 @@ getByText( ``` This will search the instance to see if there's an `stdout` output matching the -given [`TextMatch`](queries/about.mdx#textmatch). +given [`TextMatch`](#textmatch). ```html Input your name: @@ -211,7 +211,7 @@ getByText( ``` This will search the instance to see if there's an `stderr` output matching the -given [`TextMatch`](queries/about.mdx#textmatch). +given [`TextMatch`](#textmatch). ```html Could not find file diff --git a/docs/reference/classes/mutationobserver.md b/docs/reference/classes/mutationobserver.md index 159241e..06b130b 100644 --- a/docs/reference/classes/mutationobserver.md +++ b/docs/reference/classes/mutationobserver.md @@ -7,7 +7,7 @@ title: MutationObserver # Class: MutationObserver -Defined in: [mutation-observer.ts:9](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L9) +Defined in: [mutation-observer.ts:9](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L9) ## Constructors @@ -17,7 +17,7 @@ Defined in: [mutation-observer.ts:9](https://github.com/crutchcorn/cli-testing-l new MutationObserver(cb): MutationObserver ``` -Defined in: [mutation-observer.ts:13](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L13) +Defined in: [mutation-observer.ts:13](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L13) #### Parameters @@ -37,7 +37,7 @@ Defined in: [mutation-observer.ts:13](https://github.com/crutchcorn/cli-testing- _cb: () => void; ``` -Defined in: [mutation-observer.ts:10](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L10) +Defined in: [mutation-observer.ts:10](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L10) #### Returns @@ -51,7 +51,7 @@ Defined in: [mutation-observer.ts:10](https://github.com/crutchcorn/cli-testing- _id: number; ``` -Defined in: [mutation-observer.ts:11](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L11) +Defined in: [mutation-observer.ts:11](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L11) ## Methods @@ -61,7 +61,7 @@ Defined in: [mutation-observer.ts:11](https://github.com/crutchcorn/cli-testing- disconnect(): void ``` -Defined in: [mutation-observer.ts:22](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L22) +Defined in: [mutation-observer.ts:22](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L22) #### Returns @@ -75,7 +75,7 @@ Defined in: [mutation-observer.ts:22](https://github.com/crutchcorn/cli-testing- observe(): void ``` -Defined in: [mutation-observer.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L18) +Defined in: [mutation-observer.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L18) #### Returns diff --git a/docs/reference/functions/bindobjectfnstoinstance.md b/docs/reference/functions/bindobjectfnstoinstance.md index e75d7ed..dfa8d44 100644 --- a/docs/reference/functions/bindobjectfnstoinstance.md +++ b/docs/reference/functions/bindobjectfnstoinstance.md @@ -11,7 +11,7 @@ title: bindObjectFnsToInstance function bindObjectFnsToInstance(instance, object): Record unknown> ``` -Defined in: [helpers.ts:75](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L75) +Defined in: [helpers.ts:75](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L75) This is used to bind a series of functions where `instance` is the first argument to an instance, removing the implicit first argument. diff --git a/docs/reference/functions/buildqueries.md b/docs/reference/functions/buildqueries.md index d8dd6b0..a5da4e4 100644 --- a/docs/reference/functions/buildqueries.md +++ b/docs/reference/functions/buildqueries.md @@ -11,7 +11,7 @@ title: buildQueries function buildQueries(queryBy, getMissingError): readonly [(container, ...args) => T, (container, ...args) => T, (instance, text, options?, waitForOptions?) => Promise] ``` -Defined in: [query-helpers.ts:115](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L115) +Defined in: [query-helpers.ts:115](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L115) ## Parameters diff --git a/docs/reference/functions/cleanup.md b/docs/reference/functions/cleanup.md index 1c25f79..927efba 100644 --- a/docs/reference/functions/cleanup.md +++ b/docs/reference/functions/cleanup.md @@ -11,7 +11,7 @@ title: cleanup function cleanup(): Promise ``` -Defined in: [pure.ts:167](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L167) +Defined in: [pure.ts:167](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L167) ## Returns diff --git a/docs/reference/functions/configure.md b/docs/reference/functions/configure.md index e71d1ca..0e95d51 100644 --- a/docs/reference/functions/configure.md +++ b/docs/reference/functions/configure.md @@ -11,7 +11,7 @@ title: configure function configure(newConfig): void ``` -Defined in: [config.ts:77](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L77) +Defined in: [config.ts:77](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L77) ## Parameters diff --git a/docs/reference/functions/debounce.md b/docs/reference/functions/debounce.md index 7a0944a..d6cd795 100644 --- a/docs/reference/functions/debounce.md +++ b/docs/reference/functions/debounce.md @@ -11,7 +11,7 @@ title: debounce function debounce(func, timeout): (...args) => void ``` -Defined in: [helpers.ts:56](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L56) +Defined in: [helpers.ts:56](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L56) ## Type Parameters diff --git a/docs/reference/functions/fireevent.md b/docs/reference/functions/fireevent.md index e388ea8..76b797e 100644 --- a/docs/reference/functions/fireevent.md +++ b/docs/reference/functions/fireevent.md @@ -14,7 +14,7 @@ function fireEvent( options?): boolean | Promise ``` -Defined in: [events.ts:20](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L20) +Defined in: [events.ts:20](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L20) ## Type Parameters diff --git a/docs/reference/functions/getconfig.md b/docs/reference/functions/getconfig.md index 05918ee..f3fd49a 100644 --- a/docs/reference/functions/getconfig.md +++ b/docs/reference/functions/getconfig.md @@ -11,7 +11,7 @@ title: getConfig function getConfig(): Config ``` -Defined in: [config.ts:91](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L91) +Defined in: [config.ts:91](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L91) ## Returns diff --git a/docs/reference/functions/getcurrentinstance.md b/docs/reference/functions/getcurrentinstance.md index 33f838c..6d29388 100644 --- a/docs/reference/functions/getcurrentinstance.md +++ b/docs/reference/functions/getcurrentinstance.md @@ -11,7 +11,7 @@ title: getCurrentInstance function getCurrentInstance(): undefined | TestInstance ``` -Defined in: [helpers.ts:33](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L33) +Defined in: [helpers.ts:33](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L33) ## Returns diff --git a/docs/reference/functions/getdefaultnormalizer.md b/docs/reference/functions/getdefaultnormalizer.md index 5c449c9..36c262b 100644 --- a/docs/reference/functions/getdefaultnormalizer.md +++ b/docs/reference/functions/getdefaultnormalizer.md @@ -11,7 +11,7 @@ title: getDefaultNormalizer function getDefaultNormalizer(__namedParameters): NormalizerFn ``` -Defined in: [matches.ts:104](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L104) +Defined in: [matches.ts:104](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L104) ## Parameters diff --git a/docs/reference/functions/getinstanceerror.md b/docs/reference/functions/getinstanceerror.md index 9fcad19..db12dec 100644 --- a/docs/reference/functions/getinstanceerror.md +++ b/docs/reference/functions/getinstanceerror.md @@ -11,7 +11,7 @@ title: getInstanceError function getInstanceError(message, instance): Error ``` -Defined in: [query-helpers.ts:26](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L26) +Defined in: [query-helpers.ts:26](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L26) ## Parameters diff --git a/docs/reference/functions/getqueriesforelement.md b/docs/reference/functions/getqueriesforelement.md index 8076214..a7bfe50 100644 --- a/docs/reference/functions/getqueriesforelement.md +++ b/docs/reference/functions/getqueriesforelement.md @@ -14,7 +14,7 @@ function getQueriesForElement( initialValue): BoundFunctions ``` -Defined in: [get-queries-for-instance.ts:50](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L50) +Defined in: [get-queries-for-instance.ts:50](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L50) ## Type Parameters diff --git a/docs/reference/functions/jestfaketimersareenabled.md b/docs/reference/functions/jestfaketimersareenabled.md index eb29455..e592185 100644 --- a/docs/reference/functions/jestfaketimersareenabled.md +++ b/docs/reference/functions/jestfaketimersareenabled.md @@ -11,7 +11,7 @@ title: jestFakeTimersAreEnabled function jestFakeTimersAreEnabled(): boolean ``` -Defined in: [helpers.ts:3](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L3) +Defined in: [helpers.ts:3](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L3) ## Returns diff --git a/docs/reference/functions/makefindquery.md b/docs/reference/functions/makefindquery.md index 25a0bfc..7632a3f 100644 --- a/docs/reference/functions/makefindquery.md +++ b/docs/reference/functions/makefindquery.md @@ -11,7 +11,7 @@ title: makeFindQuery function makeFindQuery(getter): (instance, text, options?, waitForOptions?) => Promise ``` -Defined in: [query-helpers.ts:66](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L66) +Defined in: [query-helpers.ts:66](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L66) ## Type Parameters diff --git a/docs/reference/functions/makenormalizer.md b/docs/reference/functions/makenormalizer.md index 7193bed..daad0b9 100644 --- a/docs/reference/functions/makenormalizer.md +++ b/docs/reference/functions/makenormalizer.md @@ -11,7 +11,7 @@ title: makeNormalizer function makeNormalizer(props): NormalizerFn ``` -Defined in: [matches.ts:132](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L132) +Defined in: [matches.ts:132](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L132) ## Parameters diff --git a/docs/reference/functions/render.md b/docs/reference/functions/render.md index 6f79208..6a84de0 100644 --- a/docs/reference/functions/render.md +++ b/docs/reference/functions/render.md @@ -14,7 +14,7 @@ function render( opts): Promise ``` -Defined in: [pure.ts:40](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L40) +Defined in: [pure.ts:40](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L40) ## Parameters diff --git a/docs/reference/functions/runobservers.md b/docs/reference/functions/runobservers.md index 0baa3a9..2364a4a 100644 --- a/docs/reference/functions/runobservers.md +++ b/docs/reference/functions/runobservers.md @@ -11,7 +11,7 @@ title: _runObservers function _runObservers(): void ``` -Defined in: [mutation-observer.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L27) +Defined in: [mutation-observer.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L27) ## Returns diff --git a/docs/reference/functions/runwithexpensiveerrordiagnosticsdisabled.md b/docs/reference/functions/runwithexpensiveerrordiagnosticsdisabled.md index 98d070f..bc0d330 100644 --- a/docs/reference/functions/runwithexpensiveerrordiagnosticsdisabled.md +++ b/docs/reference/functions/runwithexpensiveerrordiagnosticsdisabled.md @@ -11,7 +11,7 @@ title: runWithExpensiveErrorDiagnosticsDisabled function runWithExpensiveErrorDiagnosticsDisabled(callback): T ``` -Defined in: [config.ts:66](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L66) +Defined in: [config.ts:66](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L66) ## Type Parameters diff --git a/docs/reference/functions/setcurrentinstance.md b/docs/reference/functions/setcurrentinstance.md index 3acc0c4..c18395d 100644 --- a/docs/reference/functions/setcurrentinstance.md +++ b/docs/reference/functions/setcurrentinstance.md @@ -11,7 +11,7 @@ title: setCurrentInstance function setCurrentInstance(newInstance): void ``` -Defined in: [helpers.ts:52](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L52) +Defined in: [helpers.ts:52](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L52) ## Parameters diff --git a/docs/reference/functions/waitfor.md b/docs/reference/functions/waitfor.md index bb4423b..6c8aead 100644 --- a/docs/reference/functions/waitfor.md +++ b/docs/reference/functions/waitfor.md @@ -11,7 +11,7 @@ title: waitFor function waitFor(callback, options?): Promise ``` -Defined in: [wait-for.ts:196](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L196) +Defined in: [wait-for.ts:196](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L196) ## Type Parameters diff --git a/docs/reference/functions/wrapsinglequerywithsuggestion.md b/docs/reference/functions/wrapsinglequerywithsuggestion.md index 3077442..68d3f55 100644 --- a/docs/reference/functions/wrapsinglequerywithsuggestion.md +++ b/docs/reference/functions/wrapsinglequerywithsuggestion.md @@ -14,7 +14,7 @@ function wrapSingleQueryWithSuggestion( variant): (container, ...args) => T ``` -Defined in: [query-helpers.ts:89](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L89) +Defined in: [query-helpers.ts:89](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L89) ## Type Parameters diff --git a/docs/reference/interfaces/config.md b/docs/reference/interfaces/config.md index 97837de..58b44c5 100644 --- a/docs/reference/interfaces/config.md +++ b/docs/reference/interfaces/config.md @@ -7,7 +7,7 @@ title: Config # Interface: Config -Defined in: [config.ts:5](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L5) +Defined in: [config.ts:5](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L5) ## Properties @@ -17,7 +17,7 @@ Defined in: [config.ts:5](https://github.com/crutchcorn/cli-testing-library/blob asyncUtilTimeout: number; ``` -Defined in: [config.ts:13](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L13) +Defined in: [config.ts:13](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L13) *** @@ -27,7 +27,7 @@ Defined in: [config.ts:13](https://github.com/crutchcorn/cli-testing-library/blo errorDebounceTimeout: number; ``` -Defined in: [config.ts:15](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L15) +Defined in: [config.ts:15](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L15) *** @@ -37,7 +37,7 @@ Defined in: [config.ts:15](https://github.com/crutchcorn/cli-testing-library/blo getInstanceError: (message, container) => Error; ``` -Defined in: [config.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L18) +Defined in: [config.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L18) #### Parameters @@ -61,7 +61,7 @@ Defined in: [config.ts:18](https://github.com/crutchcorn/cli-testing-library/blo renderAwaitTime: number; ``` -Defined in: [config.ts:14](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L14) +Defined in: [config.ts:14](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L14) *** @@ -71,7 +71,7 @@ Defined in: [config.ts:14](https://github.com/crutchcorn/cli-testing-library/blo showOriginalStackTrace: boolean; ``` -Defined in: [config.ts:16](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L16) +Defined in: [config.ts:16](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L16) *** @@ -81,7 +81,7 @@ Defined in: [config.ts:16](https://github.com/crutchcorn/cli-testing-library/blo throwSuggestions: boolean; ``` -Defined in: [config.ts:17](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L17) +Defined in: [config.ts:17](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L17) *** @@ -91,7 +91,7 @@ Defined in: [config.ts:17](https://github.com/crutchcorn/cli-testing-library/blo unstable_advanceTimersWrapper: (cb) => unknown; ``` -Defined in: [config.ts:10](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L10) +Defined in: [config.ts:10](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L10) WARNING: `unstable` prefix means this API may change in patch and minor releases. diff --git a/docs/reference/interfaces/configfn.md b/docs/reference/interfaces/configfn.md index 563678b..fe30291 100644 --- a/docs/reference/interfaces/configfn.md +++ b/docs/reference/interfaces/configfn.md @@ -7,13 +7,13 @@ title: ConfigFn # Interface: ConfigFn() -Defined in: [config.ts:21](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L21) +Defined in: [config.ts:21](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L21) ```ts interface ConfigFn(existingConfig): Partial ``` -Defined in: [config.ts:22](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L22) +Defined in: [config.ts:22](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L22) ## Parameters diff --git a/docs/reference/interfaces/defaultnormalizeroptions.md b/docs/reference/interfaces/defaultnormalizeroptions.md index f9b0852..7efff76 100644 --- a/docs/reference/interfaces/defaultnormalizeroptions.md +++ b/docs/reference/interfaces/defaultnormalizeroptions.md @@ -7,7 +7,7 @@ title: DefaultNormalizerOptions # Interface: DefaultNormalizerOptions -Defined in: [matches.ts:37](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L37) +Defined in: [matches.ts:37](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L37) ## Extended by @@ -21,7 +21,7 @@ Defined in: [matches.ts:37](https://github.com/crutchcorn/cli-testing-library/bl optional collapseWhitespace: boolean; ``` -Defined in: [matches.ts:39](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L39) +Defined in: [matches.ts:39](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L39) *** @@ -31,7 +31,7 @@ Defined in: [matches.ts:39](https://github.com/crutchcorn/cli-testing-library/bl optional stripAnsi: boolean; ``` -Defined in: [matches.ts:40](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L40) +Defined in: [matches.ts:40](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L40) *** @@ -41,4 +41,4 @@ Defined in: [matches.ts:40](https://github.com/crutchcorn/cli-testing-library/bl optional trim: boolean; ``` -Defined in: [matches.ts:38](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L38) +Defined in: [matches.ts:38](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L38) diff --git a/docs/reference/interfaces/keyboardkey.md b/docs/reference/interfaces/keyboardkey.md index 51ed3e7..de3eed2 100644 --- a/docs/reference/interfaces/keyboardkey.md +++ b/docs/reference/interfaces/keyboardkey.md @@ -7,7 +7,7 @@ title: keyboardKey # Interface: keyboardKey -Defined in: [user-event/keyboard/types.ts:8](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L8) +Defined in: [user-event/keyboard/types.ts:8](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L8) ## Properties @@ -17,7 +17,7 @@ Defined in: [user-event/keyboard/types.ts:8](https://github.com/crutchcorn/cli-t optional code: string; ``` -Defined in: [user-event/keyboard/types.ts:10](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L10) +Defined in: [user-event/keyboard/types.ts:10](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L10) Physical location on a keyboard @@ -29,6 +29,6 @@ Physical location on a keyboard optional hex: string; ``` -Defined in: [user-event/keyboard/types.ts:12](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L12) +Defined in: [user-event/keyboard/types.ts:12](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L12) Character or functional key hex code diff --git a/docs/reference/interfaces/matcheroptions.md b/docs/reference/interfaces/matcheroptions.md index 16e4141..db8474e 100644 --- a/docs/reference/interfaces/matcheroptions.md +++ b/docs/reference/interfaces/matcheroptions.md @@ -7,7 +7,7 @@ title: MatcherOptions # Interface: MatcherOptions -Defined in: [matches.ts:17](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L17) +Defined in: [matches.ts:17](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L17) ## Extended by @@ -21,7 +21,7 @@ Defined in: [matches.ts:17](https://github.com/crutchcorn/cli-testing-library/bl optional collapseWhitespace: boolean; ``` -Defined in: [matches.ts:24](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L24) +Defined in: [matches.ts:24](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L24) Use normalizer with getDefaultNormalizer instead @@ -33,7 +33,7 @@ Use normalizer with getDefaultNormalizer instead optional exact: boolean; ``` -Defined in: [matches.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L18) +Defined in: [matches.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L18) *** @@ -43,7 +43,7 @@ Defined in: [matches.ts:18](https://github.com/crutchcorn/cli-testing-library/bl optional normalizer: NormalizerFn; ``` -Defined in: [matches.ts:25](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L25) +Defined in: [matches.ts:25](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L25) *** @@ -53,7 +53,7 @@ Defined in: [matches.ts:25](https://github.com/crutchcorn/cli-testing-library/bl optional stripAnsi: boolean; ``` -Defined in: [matches.ts:22](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L22) +Defined in: [matches.ts:22](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L22) Use normalizer with getDefaultNormalizer instead @@ -65,7 +65,7 @@ Use normalizer with getDefaultNormalizer instead optional suggest: boolean; ``` -Defined in: [matches.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L27) +Defined in: [matches.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L27) suppress suggestions for a specific query @@ -77,6 +77,6 @@ suppress suggestions for a specific query optional trim: boolean; ``` -Defined in: [matches.ts:20](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L20) +Defined in: [matches.ts:20](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L20) Use normalizer with getDefaultNormalizer instead diff --git a/docs/reference/interfaces/normalizeroptions.md b/docs/reference/interfaces/normalizeroptions.md index ea4d267..b04479f 100644 --- a/docs/reference/interfaces/normalizeroptions.md +++ b/docs/reference/interfaces/normalizeroptions.md @@ -7,7 +7,7 @@ title: NormalizerOptions # Interface: NormalizerOptions -Defined in: [matches.ts:13](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L13) +Defined in: [matches.ts:13](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L13) ## Extends @@ -21,7 +21,7 @@ Defined in: [matches.ts:13](https://github.com/crutchcorn/cli-testing-library/bl optional collapseWhitespace: boolean; ``` -Defined in: [matches.ts:39](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L39) +Defined in: [matches.ts:39](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L39) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [matches.ts:39](https://github.com/crutchcorn/cli-testing-library/bl optional normalizer: NormalizerFn; ``` -Defined in: [matches.ts:14](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L14) +Defined in: [matches.ts:14](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L14) *** @@ -45,7 +45,7 @@ Defined in: [matches.ts:14](https://github.com/crutchcorn/cli-testing-library/bl optional stripAnsi: boolean; ``` -Defined in: [matches.ts:40](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L40) +Defined in: [matches.ts:40](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L40) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [matches.ts:40](https://github.com/crutchcorn/cli-testing-library/bl optional trim: boolean; ``` -Defined in: [matches.ts:38](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L38) +Defined in: [matches.ts:38](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L38) #### Inherited from diff --git a/docs/reference/interfaces/queries.md b/docs/reference/interfaces/queries.md index fd33e3b..18b7cb2 100644 --- a/docs/reference/interfaces/queries.md +++ b/docs/reference/interfaces/queries.md @@ -7,7 +7,7 @@ title: Queries # Interface: Queries -Defined in: [get-queries-for-instance.ts:40](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L40) +Defined in: [get-queries-for-instance.ts:40](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L40) ## Indexable diff --git a/docs/reference/interfaces/renderoptions.md b/docs/reference/interfaces/renderoptions.md index 8b4e88a..718c42f 100644 --- a/docs/reference/interfaces/renderoptions.md +++ b/docs/reference/interfaces/renderoptions.md @@ -7,7 +7,7 @@ title: RenderOptions # Interface: RenderOptions -Defined in: [pure.ts:24](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L24) +Defined in: [pure.ts:24](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L24) ## Properties @@ -17,7 +17,7 @@ Defined in: [pure.ts:24](https://github.com/crutchcorn/cli-testing-library/blob/ cwd: string; ``` -Defined in: [pure.ts:25](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L25) +Defined in: [pure.ts:25](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L25) *** @@ -27,7 +27,7 @@ Defined in: [pure.ts:25](https://github.com/crutchcorn/cli-testing-library/blob/ debug: boolean; ``` -Defined in: [pure.ts:26](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L26) +Defined in: [pure.ts:26](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L26) *** @@ -37,4 +37,4 @@ Defined in: [pure.ts:26](https://github.com/crutchcorn/cli-testing-library/blob/ spawnOpts: Omit; ``` -Defined in: [pure.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L27) +Defined in: [pure.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L27) diff --git a/docs/reference/interfaces/selectormatcheroptions.md b/docs/reference/interfaces/selectormatcheroptions.md index 82fe404..e33fe60 100644 --- a/docs/reference/interfaces/selectormatcheroptions.md +++ b/docs/reference/interfaces/selectormatcheroptions.md @@ -7,7 +7,7 @@ title: SelectorMatcherOptions # Interface: SelectorMatcherOptions -Defined in: [query-helpers.ts:16](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L16) +Defined in: [query-helpers.ts:16](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L16) ## Extends @@ -21,7 +21,7 @@ Defined in: [query-helpers.ts:16](https://github.com/crutchcorn/cli-testing-libr optional collapseWhitespace: boolean; ``` -Defined in: [matches.ts:24](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L24) +Defined in: [matches.ts:24](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L24) Use normalizer with getDefaultNormalizer instead @@ -37,7 +37,7 @@ Use normalizer with getDefaultNormalizer instead optional exact: boolean; ``` -Defined in: [matches.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L18) +Defined in: [matches.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L18) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [matches.ts:18](https://github.com/crutchcorn/cli-testing-library/bl optional ignore: string | boolean; ``` -Defined in: [query-helpers.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L18) +Defined in: [query-helpers.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L18) *** @@ -61,7 +61,7 @@ Defined in: [query-helpers.ts:18](https://github.com/crutchcorn/cli-testing-libr optional normalizer: NormalizerFn; ``` -Defined in: [matches.ts:25](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L25) +Defined in: [matches.ts:25](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L25) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [matches.ts:25](https://github.com/crutchcorn/cli-testing-library/bl optional selector: string; ``` -Defined in: [query-helpers.ts:17](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L17) +Defined in: [query-helpers.ts:17](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L17) *** @@ -85,7 +85,7 @@ Defined in: [query-helpers.ts:17](https://github.com/crutchcorn/cli-testing-libr optional stripAnsi: boolean; ``` -Defined in: [matches.ts:22](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L22) +Defined in: [matches.ts:22](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L22) Use normalizer with getDefaultNormalizer instead @@ -101,7 +101,7 @@ Use normalizer with getDefaultNormalizer instead optional suggest: boolean; ``` -Defined in: [matches.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L27) +Defined in: [matches.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L27) suppress suggestions for a specific query @@ -117,7 +117,7 @@ suppress suggestions for a specific query optional trim: boolean; ``` -Defined in: [matches.ts:20](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L20) +Defined in: [matches.ts:20](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L20) Use normalizer with getDefaultNormalizer instead diff --git a/docs/reference/interfaces/waitforoptions.md b/docs/reference/interfaces/waitforoptions.md index f90cce4..c6b6005 100644 --- a/docs/reference/interfaces/waitforoptions.md +++ b/docs/reference/interfaces/waitforoptions.md @@ -7,7 +7,7 @@ title: waitForOptions # Interface: waitForOptions -Defined in: [wait-for.ts:14](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L14) +Defined in: [wait-for.ts:14](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L14) ## Properties @@ -17,7 +17,7 @@ Defined in: [wait-for.ts:14](https://github.com/crutchcorn/cli-testing-library/b optional instance: TestInstance; ``` -Defined in: [wait-for.ts:15](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L15) +Defined in: [wait-for.ts:15](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L15) *** @@ -27,7 +27,7 @@ Defined in: [wait-for.ts:15](https://github.com/crutchcorn/cli-testing-library/b optional interval: number; ``` -Defined in: [wait-for.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L18) +Defined in: [wait-for.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L18) *** @@ -37,7 +37,7 @@ Defined in: [wait-for.ts:18](https://github.com/crutchcorn/cli-testing-library/b optional onTimeout: (error) => Error; ``` -Defined in: [wait-for.ts:19](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L19) +Defined in: [wait-for.ts:19](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L19) #### Parameters @@ -57,7 +57,7 @@ Defined in: [wait-for.ts:19](https://github.com/crutchcorn/cli-testing-library/b optional showOriginalStackTrace: boolean; ``` -Defined in: [wait-for.ts:16](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L16) +Defined in: [wait-for.ts:16](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L16) *** @@ -67,7 +67,7 @@ Defined in: [wait-for.ts:16](https://github.com/crutchcorn/cli-testing-library/b optional stackTraceError: Error; ``` -Defined in: [wait-for.ts:20](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L20) +Defined in: [wait-for.ts:20](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L20) *** @@ -77,4 +77,4 @@ Defined in: [wait-for.ts:20](https://github.com/crutchcorn/cli-testing-library/b optional timeout: number; ``` -Defined in: [wait-for.ts:17](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L17) +Defined in: [wait-for.ts:17](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L17) diff --git a/docs/reference/namespaces/queries/functions/findbyerror.md b/docs/reference/namespaces/queries/functions/findbyerror.md index deada4b..f27b651 100644 --- a/docs/reference/namespaces/queries/functions/findbyerror.md +++ b/docs/reference/namespaces/queries/functions/findbyerror.md @@ -11,7 +11,7 @@ title: findByError function findByError(...args): ReturnType> ``` -Defined in: [queries/error.ts:71](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L71) +Defined in: [queries/error.ts:71](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L71) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/findbytext.md b/docs/reference/namespaces/queries/functions/findbytext.md index 06ac6b8..a205ec2 100644 --- a/docs/reference/namespaces/queries/functions/findbytext.md +++ b/docs/reference/namespaces/queries/functions/findbytext.md @@ -11,7 +11,7 @@ title: findByText function findByText(...args): ReturnType> ``` -Defined in: [queries/text.ts:69](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L69) +Defined in: [queries/text.ts:69](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L69) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/getbyerror.md b/docs/reference/namespaces/queries/functions/getbyerror.md index 084c41f..df68485 100644 --- a/docs/reference/namespaces/queries/functions/getbyerror.md +++ b/docs/reference/namespaces/queries/functions/getbyerror.md @@ -11,7 +11,7 @@ title: getByError function getByError(...args): ReturnType> ``` -Defined in: [queries/error.ts:59](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L59) +Defined in: [queries/error.ts:59](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L59) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/getbytext.md b/docs/reference/namespaces/queries/functions/getbytext.md index 0b648df..d208e1c 100644 --- a/docs/reference/namespaces/queries/functions/getbytext.md +++ b/docs/reference/namespaces/queries/functions/getbytext.md @@ -11,7 +11,7 @@ title: getByText function getByText(...args): ReturnType> ``` -Defined in: [queries/text.ts:59](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L59) +Defined in: [queries/text.ts:59](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L59) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/querybyerror.md b/docs/reference/namespaces/queries/functions/querybyerror.md index 409756a..89dc288 100644 --- a/docs/reference/namespaces/queries/functions/querybyerror.md +++ b/docs/reference/namespaces/queries/functions/querybyerror.md @@ -11,7 +11,7 @@ title: queryByError function queryByError(...args): ReturnType> ``` -Defined in: [queries/error.ts:65](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L65) +Defined in: [queries/error.ts:65](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L65) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/querybytext.md b/docs/reference/namespaces/queries/functions/querybytext.md index 28440e0..695c282 100644 --- a/docs/reference/namespaces/queries/functions/querybytext.md +++ b/docs/reference/namespaces/queries/functions/querybytext.md @@ -11,7 +11,7 @@ title: queryByText function queryByText(...args): ReturnType> ``` -Defined in: [queries/text.ts:64](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L64) +Defined in: [queries/text.ts:64](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L64) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/findbyerror.md b/docs/reference/namespaces/queries/type-aliases/findbyerror.md index 0f4abb9..ead4646 100644 --- a/docs/reference/namespaces/queries/type-aliases/findbyerror.md +++ b/docs/reference/namespaces/queries/type-aliases/findbyerror.md @@ -11,7 +11,7 @@ title: FindByError type FindByError = (instance, id, options?, waitForElementOptions?) => Promise; ``` -Defined in: [queries/error.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L27) +Defined in: [queries/error.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L27) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/findbytext.md b/docs/reference/namespaces/queries/type-aliases/findbytext.md index 76b9ba8..fe85823 100644 --- a/docs/reference/namespaces/queries/type-aliases/findbytext.md +++ b/docs/reference/namespaces/queries/type-aliases/findbytext.md @@ -11,7 +11,7 @@ title: FindByText type FindByText = (instance, id, options?, waitForElementOptions?) => Promise; ``` -Defined in: [queries/text.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L27) +Defined in: [queries/text.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L27) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/getbyerror.md b/docs/reference/namespaces/queries/type-aliases/getbyerror.md index 434aa8b..cab261c 100644 --- a/docs/reference/namespaces/queries/type-aliases/getbyerror.md +++ b/docs/reference/namespaces/queries/type-aliases/getbyerror.md @@ -11,7 +11,7 @@ title: GetByError type GetByError = (instance, id, options?) => T; ``` -Defined in: [queries/error.ts:21](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L21) +Defined in: [queries/error.ts:21](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L21) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/getbytext.md b/docs/reference/namespaces/queries/type-aliases/getbytext.md index 3e4d0f2..904925b 100644 --- a/docs/reference/namespaces/queries/type-aliases/getbytext.md +++ b/docs/reference/namespaces/queries/type-aliases/getbytext.md @@ -11,7 +11,7 @@ title: GetByText type GetByText = (instance, id, options?) => T; ``` -Defined in: [queries/text.ts:21](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L21) +Defined in: [queries/text.ts:21](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L21) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/querybyerror.md b/docs/reference/namespaces/queries/type-aliases/querybyerror.md index 80d593a..66c6e9a 100644 --- a/docs/reference/namespaces/queries/type-aliases/querybyerror.md +++ b/docs/reference/namespaces/queries/type-aliases/querybyerror.md @@ -11,7 +11,7 @@ title: QueryByError type QueryByError = (instance, id, options?) => T | null; ``` -Defined in: [queries/error.ts:15](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L15) +Defined in: [queries/error.ts:15](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L15) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/querybytext.md b/docs/reference/namespaces/queries/type-aliases/querybytext.md index 4d51f8d..15452ee 100644 --- a/docs/reference/namespaces/queries/type-aliases/querybytext.md +++ b/docs/reference/namespaces/queries/type-aliases/querybytext.md @@ -11,7 +11,7 @@ title: QueryByText type QueryByText = (instance, id, options?) => T | null; ``` -Defined in: [queries/text.ts:15](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L15) +Defined in: [queries/text.ts:15](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L15) ## Type Parameters diff --git a/docs/reference/type-aliases/boundfunction.md b/docs/reference/type-aliases/boundfunction.md index 9fa91de..69474a9 100644 --- a/docs/reference/type-aliases/boundfunction.md +++ b/docs/reference/type-aliases/boundfunction.md @@ -11,7 +11,7 @@ title: BoundFunction type BoundFunction = T extends (container, ...args) => infer R ? (...args) => R : never; ``` -Defined in: [get-queries-for-instance.ts:4](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L4) +Defined in: [get-queries-for-instance.ts:4](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L4) ## Type Parameters diff --git a/docs/reference/type-aliases/boundfunctions.md b/docs/reference/type-aliases/boundfunctions.md index 177271f..b0987e1 100644 --- a/docs/reference/type-aliases/boundfunctions.md +++ b/docs/reference/type-aliases/boundfunctions.md @@ -11,7 +11,7 @@ title: BoundFunctions type BoundFunctions = TQueries extends typeof queries ? object & { [P in keyof TQueries]: BoundFunction } : { [P in keyof TQueries]: BoundFunction }; ``` -Defined in: [get-queries-for-instance.ts:11](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L11) +Defined in: [get-queries-for-instance.ts:11](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L11) ## Type Parameters diff --git a/docs/reference/type-aliases/eventtype.md b/docs/reference/type-aliases/eventtype.md index 97e2b2e..d0fca31 100644 --- a/docs/reference/type-aliases/eventtype.md +++ b/docs/reference/type-aliases/eventtype.md @@ -11,4 +11,4 @@ title: EventType type EventType = keyof EventMap; ``` -Defined in: [events.ts:5](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L5) +Defined in: [events.ts:5](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L5) diff --git a/docs/reference/type-aliases/firefunction.md b/docs/reference/type-aliases/firefunction.md index 34678d4..9aab7cf 100644 --- a/docs/reference/type-aliases/firefunction.md +++ b/docs/reference/type-aliases/firefunction.md @@ -11,7 +11,7 @@ title: FireFunction type FireFunction = (instance, event, options?) => boolean | Promise; ``` -Defined in: [events.ts:7](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L7) +Defined in: [events.ts:7](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L7) ## Type Parameters diff --git a/docs/reference/type-aliases/fireobject.md b/docs/reference/type-aliases/fireobject.md index 98fd944..f9582b1 100644 --- a/docs/reference/type-aliases/fireobject.md +++ b/docs/reference/type-aliases/fireobject.md @@ -11,4 +11,4 @@ title: FireObject type FireObject = { [K in EventType]: (instance: TestInstance, options?: Parameters[1]) => boolean | Promise }; ``` -Defined in: [events.ts:13](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L13) +Defined in: [events.ts:13](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L13) diff --git a/docs/reference/type-aliases/geterrorfunction.md b/docs/reference/type-aliases/geterrorfunction.md index 4b6626a..137c358 100644 --- a/docs/reference/type-aliases/geterrorfunction.md +++ b/docs/reference/type-aliases/geterrorfunction.md @@ -11,7 +11,7 @@ title: GetErrorFunction type GetErrorFunction = (c, ...args) => string; ``` -Defined in: [query-helpers.ts:11](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L11) +Defined in: [query-helpers.ts:11](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L11) ## Type Parameters diff --git a/docs/reference/type-aliases/match.md b/docs/reference/type-aliases/match.md index 3271237..1302ed3 100644 --- a/docs/reference/type-aliases/match.md +++ b/docs/reference/type-aliases/match.md @@ -11,7 +11,7 @@ title: Match type Match = (textToMatch, node, matcher, options?) => boolean; ``` -Defined in: [matches.ts:30](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L30) +Defined in: [matches.ts:30](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L30) ## Parameters diff --git a/docs/reference/type-aliases/matcher.md b/docs/reference/type-aliases/matcher.md index 4fff396..3c8a4ac 100644 --- a/docs/reference/type-aliases/matcher.md +++ b/docs/reference/type-aliases/matcher.md @@ -11,4 +11,4 @@ title: Matcher type Matcher = MatcherFunction | RegExp | number | string; ``` -Defined in: [matches.ts:9](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L9) +Defined in: [matches.ts:9](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L9) diff --git a/docs/reference/type-aliases/matcherfunction.md b/docs/reference/type-aliases/matcherfunction.md index 828139f..c0c4362 100644 --- a/docs/reference/type-aliases/matcherfunction.md +++ b/docs/reference/type-aliases/matcherfunction.md @@ -11,7 +11,7 @@ title: MatcherFunction type MatcherFunction = (content, element) => boolean; ``` -Defined in: [matches.ts:4](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L4) +Defined in: [matches.ts:4](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L4) ## Parameters diff --git a/docs/reference/type-aliases/normalizerfn.md b/docs/reference/type-aliases/normalizerfn.md index cf5e34e..7461c34 100644 --- a/docs/reference/type-aliases/normalizerfn.md +++ b/docs/reference/type-aliases/normalizerfn.md @@ -11,7 +11,7 @@ title: NormalizerFn type NormalizerFn = (text) => string; ``` -Defined in: [matches.ts:11](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L11) +Defined in: [matches.ts:11](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L11) ## Parameters diff --git a/docs/reference/type-aliases/query.md b/docs/reference/type-aliases/query.md index 7353892..82a06a9 100644 --- a/docs/reference/type-aliases/query.md +++ b/docs/reference/type-aliases/query.md @@ -17,7 +17,7 @@ type Query = (container, ...args) => | null; ``` -Defined in: [get-queries-for-instance.ts:29](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L29) +Defined in: [get-queries-for-instance.ts:29](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L29) ## Parameters diff --git a/docs/reference/type-aliases/querymethod.md b/docs/reference/type-aliases/querymethod.md index 25f0906..a9202af 100644 --- a/docs/reference/type-aliases/querymethod.md +++ b/docs/reference/type-aliases/querymethod.md @@ -11,7 +11,7 @@ title: QueryMethod type QueryMethod = (container, ...args) => TReturn; ``` -Defined in: [query-helpers.ts:21](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L21) +Defined in: [query-helpers.ts:21](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L21) ## Type Parameters diff --git a/docs/reference/type-aliases/renderresult.md b/docs/reference/type-aliases/renderresult.md index 51c6836..e89dde4 100644 --- a/docs/reference/type-aliases/renderresult.md +++ b/docs/reference/type-aliases/renderresult.md @@ -11,7 +11,7 @@ title: RenderResult type RenderResult = TestInstance & object & { [P in keyof typeof queries]: BoundFunction }; ``` -Defined in: [pure.ts:32](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L32) +Defined in: [pure.ts:32](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L32) ## Type declaration diff --git a/docs/reference/type-aliases/withsuggest.md b/docs/reference/type-aliases/withsuggest.md index f096a97..cb28636 100644 --- a/docs/reference/type-aliases/withsuggest.md +++ b/docs/reference/type-aliases/withsuggest.md @@ -11,7 +11,7 @@ title: WithSuggest type WithSuggest = object; ``` -Defined in: [query-helpers.ts:9](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L9) +Defined in: [query-helpers.ts:9](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L9) ## Type declaration diff --git a/docs/user-event.md b/docs/user-event.md index 7e8199b..dd46227 100644 --- a/docs/user-event.md +++ b/docs/user-event.md @@ -3,7 +3,7 @@ title: "User Event" --- [`user-event`][gh] is a helper that provides more advanced simulation of CLI -interactions than the [`fireEvent`](./fire-event) method. +interactions than the [`fireEvent`](./fire-event.md) method. ## Import @@ -66,7 +66,7 @@ Keystrokes can be described: userEvent.keyboard('a[[') // translates to: a, [ ``` -- Per [special key mapping](../src/user-event/keyboard/keyMap.ts) with the `[` +- Per [special key mapping](../packages/cli-testing-library/src/user-event/keyboard/keyMap.ts) with the `[` symbol ```js @@ -77,7 +77,7 @@ Keystrokes can be described: `f`. The mapping of special character strings are performed by a -[default key map](../src/user-event/keyboard/keyMap.ts) portraying a "default" +[default key map](../packages/cli-testing-library/src/user-event/keyboard/keyMap.ts) portraying a "default" US-keyboard. You can provide your own local keyboard mapping per option. ```js @@ -106,6 +106,6 @@ mentioned previously. Here are some of the ones that are supported: | `[End]` | End | A full list of supported special characters that can be input can be found -[in our key mapping file](../src/user-event/keyboard/keyMap.ts). +[in our key mapping file](../packages/cli-testing-library/src/user-event/keyboard/keyMap.ts). [gh]: https://github.com/testing-library/user-event From 1ff1969518eda10b90aed0083ac8890977f8f277 Mon Sep 17 00:00:00 2001 From: Romuald Oluwatobi Date: Thu, 8 May 2025 07:03:39 +0100 Subject: [PATCH 2/4] fix: add rehype plugin to fix website links --- pnpm-lock.yaml | 3 +++ website/astro.config.mjs | 5 +++++ website/package.json | 3 ++- website/rehype-plugin.js | 23 +++++++++++++++++++++++ 4 files changed, 33 insertions(+), 1 deletion(-) create mode 100644 website/rehype-plugin.js diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index e51ee6b..05cde07 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -135,6 +135,9 @@ importers: sharp: specifier: ^0.33.5 version: 0.33.5 + unist-util-visit: + specifier: ^5.0.0 + version: 5.0.0 devDependencies: '@types/react': specifier: ^19.0.2 diff --git a/website/astro.config.mjs b/website/astro.config.mjs index 82c6702..5f3d7a8 100644 --- a/website/astro.config.mjs +++ b/website/astro.config.mjs @@ -3,8 +3,13 @@ import { defineConfig } from "astro/config"; import starlight from "@astrojs/starlight"; import react from "@astrojs/react"; +import { rehypeHandleMdExtension } from "./rehype-plugin"; + // https://astro.build/config export default defineConfig({ + markdown: { + rehypePlugins: [rehypeHandleMdExtension] + }, integrations: [ react(), starlight({ diff --git a/website/package.json b/website/package.json index bf1a367..7024dbf 100644 --- a/website/package.json +++ b/website/package.json @@ -16,7 +16,8 @@ "astro": "^5.0.2", "react": "^19.0.0", "react-dom": "^19.0.0", - "sharp": "^0.33.5" + "sharp": "^0.33.5", + "unist-util-visit": "^5.0.0" }, "devDependencies": { "@types/react": "^19.0.2", diff --git a/website/rehype-plugin.js b/website/rehype-plugin.js new file mode 100644 index 0000000..c4fa9b0 --- /dev/null +++ b/website/rehype-plugin.js @@ -0,0 +1,23 @@ +import { visit } from "unist-util-visit"; + +export const rehypeHandleMdExtension = () => { + const pattern = /^(\.\/.+)\.md(.*)/; + + const canBeProcessed = (node) => ( + node.tagName === "a" && + node.properties.href && + pattern.test(node.properties.href) + ) + + const processNode = (node) => { + const href = node.properties.href; + const results = href.match(pattern) + node.properties.href = `${results[1]}${results[2]}`; + } + + return (tree) => { + visit(tree, "element", (node) => { + canBeProcessed(node) && processNode(node) + }) + } +} \ No newline at end of file From ee88cb4ccab958b9cb1225c802ab33ace2c864e5 Mon Sep 17 00:00:00 2001 From: Romuald Oluwatobi Date: Fri, 9 May 2025 04:48:45 +0100 Subject: [PATCH 3/4] fix: update rehype md extension handler pattern --- website/rehype-plugin.js | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/website/rehype-plugin.js b/website/rehype-plugin.js index c4fa9b0..c0cc233 100644 --- a/website/rehype-plugin.js +++ b/website/rehype-plugin.js @@ -1,7 +1,7 @@ import { visit } from "unist-util-visit"; export const rehypeHandleMdExtension = () => { - const pattern = /^(\.\/.+)\.md(.*)/; + const pattern = /^(\..+)\.md(.*)/; const canBeProcessed = (node) => ( node.tagName === "a" && From 4529355e7f02baa3b1c7d7f71798351f843bef50 Mon Sep 17 00:00:00 2001 From: Romuald Oluwatobi Date: Fri, 9 May 2025 05:08:04 +0100 Subject: [PATCH 4/4] doc: update link --- docs/reference/classes/mutationobserver.md | 12 ++++++------ .../functions/bindobjectfnstoinstance.md | 2 +- docs/reference/functions/buildqueries.md | 2 +- docs/reference/functions/cleanup.md | 2 +- docs/reference/functions/configure.md | 2 +- docs/reference/functions/debounce.md | 2 +- docs/reference/functions/fireevent.md | 2 +- docs/reference/functions/getconfig.md | 2 +- docs/reference/functions/getcurrentinstance.md | 2 +- .../functions/getdefaultnormalizer.md | 2 +- docs/reference/functions/getinstanceerror.md | 2 +- .../functions/getqueriesforelement.md | 2 +- .../functions/jestfaketimersareenabled.md | 2 +- docs/reference/functions/makefindquery.md | 2 +- docs/reference/functions/makenormalizer.md | 2 +- docs/reference/functions/render.md | 2 +- docs/reference/functions/runobservers.md | 2 +- ...runwithexpensiveerrordiagnosticsdisabled.md | 2 +- docs/reference/functions/setcurrentinstance.md | 2 +- docs/reference/functions/waitfor.md | 2 +- .../functions/wrapsinglequerywithsuggestion.md | 2 +- docs/reference/interfaces/config.md | 16 ++++++++-------- docs/reference/interfaces/configfn.md | 4 ++-- .../interfaces/defaultnormalizeroptions.md | 8 ++++---- docs/reference/interfaces/keyboardkey.md | 6 +++--- docs/reference/interfaces/matcheroptions.md | 14 +++++++------- docs/reference/interfaces/normalizeroptions.md | 10 +++++----- docs/reference/interfaces/queries.md | 2 +- docs/reference/interfaces/renderoptions.md | 8 ++++---- .../interfaces/selectormatcheroptions.md | 18 +++++++++--------- docs/reference/interfaces/waitforoptions.md | 14 +++++++------- .../queries/functions/findbyerror.md | 2 +- .../namespaces/queries/functions/findbytext.md | 2 +- .../namespaces/queries/functions/getbyerror.md | 2 +- .../namespaces/queries/functions/getbytext.md | 2 +- .../queries/functions/querybyerror.md | 2 +- .../queries/functions/querybytext.md | 2 +- .../queries/type-aliases/findbyerror.md | 2 +- .../queries/type-aliases/findbytext.md | 2 +- .../queries/type-aliases/getbyerror.md | 2 +- .../queries/type-aliases/getbytext.md | 2 +- .../queries/type-aliases/querybyerror.md | 2 +- .../queries/type-aliases/querybytext.md | 2 +- docs/reference/type-aliases/boundfunction.md | 2 +- docs/reference/type-aliases/boundfunctions.md | 2 +- docs/reference/type-aliases/eventtype.md | 2 +- docs/reference/type-aliases/firefunction.md | 2 +- docs/reference/type-aliases/fireobject.md | 2 +- .../reference/type-aliases/geterrorfunction.md | 2 +- docs/reference/type-aliases/match.md | 2 +- docs/reference/type-aliases/matcher.md | 2 +- docs/reference/type-aliases/matcherfunction.md | 2 +- docs/reference/type-aliases/normalizerfn.md | 2 +- docs/reference/type-aliases/query.md | 2 +- docs/reference/type-aliases/querymethod.md | 2 +- docs/reference/type-aliases/renderresult.md | 2 +- docs/reference/type-aliases/withsuggest.md | 2 +- 57 files changed, 102 insertions(+), 102 deletions(-) diff --git a/docs/reference/classes/mutationobserver.md b/docs/reference/classes/mutationobserver.md index 06b130b..159241e 100644 --- a/docs/reference/classes/mutationobserver.md +++ b/docs/reference/classes/mutationobserver.md @@ -7,7 +7,7 @@ title: MutationObserver # Class: MutationObserver -Defined in: [mutation-observer.ts:9](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L9) +Defined in: [mutation-observer.ts:9](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L9) ## Constructors @@ -17,7 +17,7 @@ Defined in: [mutation-observer.ts:9](https://github.com/Romulad/cli-testing-libr new MutationObserver(cb): MutationObserver ``` -Defined in: [mutation-observer.ts:13](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L13) +Defined in: [mutation-observer.ts:13](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L13) #### Parameters @@ -37,7 +37,7 @@ Defined in: [mutation-observer.ts:13](https://github.com/Romulad/cli-testing-lib _cb: () => void; ``` -Defined in: [mutation-observer.ts:10](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L10) +Defined in: [mutation-observer.ts:10](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L10) #### Returns @@ -51,7 +51,7 @@ Defined in: [mutation-observer.ts:10](https://github.com/Romulad/cli-testing-lib _id: number; ``` -Defined in: [mutation-observer.ts:11](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L11) +Defined in: [mutation-observer.ts:11](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L11) ## Methods @@ -61,7 +61,7 @@ Defined in: [mutation-observer.ts:11](https://github.com/Romulad/cli-testing-lib disconnect(): void ``` -Defined in: [mutation-observer.ts:22](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L22) +Defined in: [mutation-observer.ts:22](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L22) #### Returns @@ -75,7 +75,7 @@ Defined in: [mutation-observer.ts:22](https://github.com/Romulad/cli-testing-lib observe(): void ``` -Defined in: [mutation-observer.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L18) +Defined in: [mutation-observer.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L18) #### Returns diff --git a/docs/reference/functions/bindobjectfnstoinstance.md b/docs/reference/functions/bindobjectfnstoinstance.md index dfa8d44..e75d7ed 100644 --- a/docs/reference/functions/bindobjectfnstoinstance.md +++ b/docs/reference/functions/bindobjectfnstoinstance.md @@ -11,7 +11,7 @@ title: bindObjectFnsToInstance function bindObjectFnsToInstance(instance, object): Record unknown> ``` -Defined in: [helpers.ts:75](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L75) +Defined in: [helpers.ts:75](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L75) This is used to bind a series of functions where `instance` is the first argument to an instance, removing the implicit first argument. diff --git a/docs/reference/functions/buildqueries.md b/docs/reference/functions/buildqueries.md index a5da4e4..d8dd6b0 100644 --- a/docs/reference/functions/buildqueries.md +++ b/docs/reference/functions/buildqueries.md @@ -11,7 +11,7 @@ title: buildQueries function buildQueries(queryBy, getMissingError): readonly [(container, ...args) => T, (container, ...args) => T, (instance, text, options?, waitForOptions?) => Promise] ``` -Defined in: [query-helpers.ts:115](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L115) +Defined in: [query-helpers.ts:115](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L115) ## Parameters diff --git a/docs/reference/functions/cleanup.md b/docs/reference/functions/cleanup.md index 927efba..1c25f79 100644 --- a/docs/reference/functions/cleanup.md +++ b/docs/reference/functions/cleanup.md @@ -11,7 +11,7 @@ title: cleanup function cleanup(): Promise ``` -Defined in: [pure.ts:167](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L167) +Defined in: [pure.ts:167](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L167) ## Returns diff --git a/docs/reference/functions/configure.md b/docs/reference/functions/configure.md index 0e95d51..e71d1ca 100644 --- a/docs/reference/functions/configure.md +++ b/docs/reference/functions/configure.md @@ -11,7 +11,7 @@ title: configure function configure(newConfig): void ``` -Defined in: [config.ts:77](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L77) +Defined in: [config.ts:77](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L77) ## Parameters diff --git a/docs/reference/functions/debounce.md b/docs/reference/functions/debounce.md index d6cd795..7a0944a 100644 --- a/docs/reference/functions/debounce.md +++ b/docs/reference/functions/debounce.md @@ -11,7 +11,7 @@ title: debounce function debounce(func, timeout): (...args) => void ``` -Defined in: [helpers.ts:56](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L56) +Defined in: [helpers.ts:56](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L56) ## Type Parameters diff --git a/docs/reference/functions/fireevent.md b/docs/reference/functions/fireevent.md index 76b797e..e388ea8 100644 --- a/docs/reference/functions/fireevent.md +++ b/docs/reference/functions/fireevent.md @@ -14,7 +14,7 @@ function fireEvent( options?): boolean | Promise ``` -Defined in: [events.ts:20](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L20) +Defined in: [events.ts:20](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L20) ## Type Parameters diff --git a/docs/reference/functions/getconfig.md b/docs/reference/functions/getconfig.md index f3fd49a..05918ee 100644 --- a/docs/reference/functions/getconfig.md +++ b/docs/reference/functions/getconfig.md @@ -11,7 +11,7 @@ title: getConfig function getConfig(): Config ``` -Defined in: [config.ts:91](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L91) +Defined in: [config.ts:91](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L91) ## Returns diff --git a/docs/reference/functions/getcurrentinstance.md b/docs/reference/functions/getcurrentinstance.md index 6d29388..33f838c 100644 --- a/docs/reference/functions/getcurrentinstance.md +++ b/docs/reference/functions/getcurrentinstance.md @@ -11,7 +11,7 @@ title: getCurrentInstance function getCurrentInstance(): undefined | TestInstance ``` -Defined in: [helpers.ts:33](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L33) +Defined in: [helpers.ts:33](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L33) ## Returns diff --git a/docs/reference/functions/getdefaultnormalizer.md b/docs/reference/functions/getdefaultnormalizer.md index 36c262b..5c449c9 100644 --- a/docs/reference/functions/getdefaultnormalizer.md +++ b/docs/reference/functions/getdefaultnormalizer.md @@ -11,7 +11,7 @@ title: getDefaultNormalizer function getDefaultNormalizer(__namedParameters): NormalizerFn ``` -Defined in: [matches.ts:104](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L104) +Defined in: [matches.ts:104](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L104) ## Parameters diff --git a/docs/reference/functions/getinstanceerror.md b/docs/reference/functions/getinstanceerror.md index db12dec..9fcad19 100644 --- a/docs/reference/functions/getinstanceerror.md +++ b/docs/reference/functions/getinstanceerror.md @@ -11,7 +11,7 @@ title: getInstanceError function getInstanceError(message, instance): Error ``` -Defined in: [query-helpers.ts:26](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L26) +Defined in: [query-helpers.ts:26](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L26) ## Parameters diff --git a/docs/reference/functions/getqueriesforelement.md b/docs/reference/functions/getqueriesforelement.md index a7bfe50..8076214 100644 --- a/docs/reference/functions/getqueriesforelement.md +++ b/docs/reference/functions/getqueriesforelement.md @@ -14,7 +14,7 @@ function getQueriesForElement( initialValue): BoundFunctions ``` -Defined in: [get-queries-for-instance.ts:50](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L50) +Defined in: [get-queries-for-instance.ts:50](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L50) ## Type Parameters diff --git a/docs/reference/functions/jestfaketimersareenabled.md b/docs/reference/functions/jestfaketimersareenabled.md index e592185..eb29455 100644 --- a/docs/reference/functions/jestfaketimersareenabled.md +++ b/docs/reference/functions/jestfaketimersareenabled.md @@ -11,7 +11,7 @@ title: jestFakeTimersAreEnabled function jestFakeTimersAreEnabled(): boolean ``` -Defined in: [helpers.ts:3](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L3) +Defined in: [helpers.ts:3](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L3) ## Returns diff --git a/docs/reference/functions/makefindquery.md b/docs/reference/functions/makefindquery.md index 7632a3f..25a0bfc 100644 --- a/docs/reference/functions/makefindquery.md +++ b/docs/reference/functions/makefindquery.md @@ -11,7 +11,7 @@ title: makeFindQuery function makeFindQuery(getter): (instance, text, options?, waitForOptions?) => Promise ``` -Defined in: [query-helpers.ts:66](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L66) +Defined in: [query-helpers.ts:66](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L66) ## Type Parameters diff --git a/docs/reference/functions/makenormalizer.md b/docs/reference/functions/makenormalizer.md index daad0b9..7193bed 100644 --- a/docs/reference/functions/makenormalizer.md +++ b/docs/reference/functions/makenormalizer.md @@ -11,7 +11,7 @@ title: makeNormalizer function makeNormalizer(props): NormalizerFn ``` -Defined in: [matches.ts:132](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L132) +Defined in: [matches.ts:132](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L132) ## Parameters diff --git a/docs/reference/functions/render.md b/docs/reference/functions/render.md index 6a84de0..6f79208 100644 --- a/docs/reference/functions/render.md +++ b/docs/reference/functions/render.md @@ -14,7 +14,7 @@ function render( opts): Promise ``` -Defined in: [pure.ts:40](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L40) +Defined in: [pure.ts:40](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L40) ## Parameters diff --git a/docs/reference/functions/runobservers.md b/docs/reference/functions/runobservers.md index 2364a4a..0baa3a9 100644 --- a/docs/reference/functions/runobservers.md +++ b/docs/reference/functions/runobservers.md @@ -11,7 +11,7 @@ title: _runObservers function _runObservers(): void ``` -Defined in: [mutation-observer.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L27) +Defined in: [mutation-observer.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/mutation-observer.ts#L27) ## Returns diff --git a/docs/reference/functions/runwithexpensiveerrordiagnosticsdisabled.md b/docs/reference/functions/runwithexpensiveerrordiagnosticsdisabled.md index bc0d330..98d070f 100644 --- a/docs/reference/functions/runwithexpensiveerrordiagnosticsdisabled.md +++ b/docs/reference/functions/runwithexpensiveerrordiagnosticsdisabled.md @@ -11,7 +11,7 @@ title: runWithExpensiveErrorDiagnosticsDisabled function runWithExpensiveErrorDiagnosticsDisabled(callback): T ``` -Defined in: [config.ts:66](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L66) +Defined in: [config.ts:66](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L66) ## Type Parameters diff --git a/docs/reference/functions/setcurrentinstance.md b/docs/reference/functions/setcurrentinstance.md index c18395d..3acc0c4 100644 --- a/docs/reference/functions/setcurrentinstance.md +++ b/docs/reference/functions/setcurrentinstance.md @@ -11,7 +11,7 @@ title: setCurrentInstance function setCurrentInstance(newInstance): void ``` -Defined in: [helpers.ts:52](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L52) +Defined in: [helpers.ts:52](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/helpers.ts#L52) ## Parameters diff --git a/docs/reference/functions/waitfor.md b/docs/reference/functions/waitfor.md index 6c8aead..bb4423b 100644 --- a/docs/reference/functions/waitfor.md +++ b/docs/reference/functions/waitfor.md @@ -11,7 +11,7 @@ title: waitFor function waitFor(callback, options?): Promise ``` -Defined in: [wait-for.ts:196](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L196) +Defined in: [wait-for.ts:196](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L196) ## Type Parameters diff --git a/docs/reference/functions/wrapsinglequerywithsuggestion.md b/docs/reference/functions/wrapsinglequerywithsuggestion.md index 68d3f55..3077442 100644 --- a/docs/reference/functions/wrapsinglequerywithsuggestion.md +++ b/docs/reference/functions/wrapsinglequerywithsuggestion.md @@ -14,7 +14,7 @@ function wrapSingleQueryWithSuggestion( variant): (container, ...args) => T ``` -Defined in: [query-helpers.ts:89](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L89) +Defined in: [query-helpers.ts:89](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L89) ## Type Parameters diff --git a/docs/reference/interfaces/config.md b/docs/reference/interfaces/config.md index 58b44c5..97837de 100644 --- a/docs/reference/interfaces/config.md +++ b/docs/reference/interfaces/config.md @@ -7,7 +7,7 @@ title: Config # Interface: Config -Defined in: [config.ts:5](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L5) +Defined in: [config.ts:5](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L5) ## Properties @@ -17,7 +17,7 @@ Defined in: [config.ts:5](https://github.com/Romulad/cli-testing-library/blob/ma asyncUtilTimeout: number; ``` -Defined in: [config.ts:13](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L13) +Defined in: [config.ts:13](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L13) *** @@ -27,7 +27,7 @@ Defined in: [config.ts:13](https://github.com/Romulad/cli-testing-library/blob/m errorDebounceTimeout: number; ``` -Defined in: [config.ts:15](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L15) +Defined in: [config.ts:15](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L15) *** @@ -37,7 +37,7 @@ Defined in: [config.ts:15](https://github.com/Romulad/cli-testing-library/blob/m getInstanceError: (message, container) => Error; ``` -Defined in: [config.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L18) +Defined in: [config.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L18) #### Parameters @@ -61,7 +61,7 @@ Defined in: [config.ts:18](https://github.com/Romulad/cli-testing-library/blob/m renderAwaitTime: number; ``` -Defined in: [config.ts:14](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L14) +Defined in: [config.ts:14](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L14) *** @@ -71,7 +71,7 @@ Defined in: [config.ts:14](https://github.com/Romulad/cli-testing-library/blob/m showOriginalStackTrace: boolean; ``` -Defined in: [config.ts:16](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L16) +Defined in: [config.ts:16](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L16) *** @@ -81,7 +81,7 @@ Defined in: [config.ts:16](https://github.com/Romulad/cli-testing-library/blob/m throwSuggestions: boolean; ``` -Defined in: [config.ts:17](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L17) +Defined in: [config.ts:17](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L17) *** @@ -91,7 +91,7 @@ Defined in: [config.ts:17](https://github.com/Romulad/cli-testing-library/blob/m unstable_advanceTimersWrapper: (cb) => unknown; ``` -Defined in: [config.ts:10](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L10) +Defined in: [config.ts:10](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L10) WARNING: `unstable` prefix means this API may change in patch and minor releases. diff --git a/docs/reference/interfaces/configfn.md b/docs/reference/interfaces/configfn.md index fe30291..563678b 100644 --- a/docs/reference/interfaces/configfn.md +++ b/docs/reference/interfaces/configfn.md @@ -7,13 +7,13 @@ title: ConfigFn # Interface: ConfigFn() -Defined in: [config.ts:21](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L21) +Defined in: [config.ts:21](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L21) ```ts interface ConfigFn(existingConfig): Partial ``` -Defined in: [config.ts:22](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L22) +Defined in: [config.ts:22](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/config.ts#L22) ## Parameters diff --git a/docs/reference/interfaces/defaultnormalizeroptions.md b/docs/reference/interfaces/defaultnormalizeroptions.md index 7efff76..f9b0852 100644 --- a/docs/reference/interfaces/defaultnormalizeroptions.md +++ b/docs/reference/interfaces/defaultnormalizeroptions.md @@ -7,7 +7,7 @@ title: DefaultNormalizerOptions # Interface: DefaultNormalizerOptions -Defined in: [matches.ts:37](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L37) +Defined in: [matches.ts:37](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L37) ## Extended by @@ -21,7 +21,7 @@ Defined in: [matches.ts:37](https://github.com/Romulad/cli-testing-library/blob/ optional collapseWhitespace: boolean; ``` -Defined in: [matches.ts:39](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L39) +Defined in: [matches.ts:39](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L39) *** @@ -31,7 +31,7 @@ Defined in: [matches.ts:39](https://github.com/Romulad/cli-testing-library/blob/ optional stripAnsi: boolean; ``` -Defined in: [matches.ts:40](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L40) +Defined in: [matches.ts:40](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L40) *** @@ -41,4 +41,4 @@ Defined in: [matches.ts:40](https://github.com/Romulad/cli-testing-library/blob/ optional trim: boolean; ``` -Defined in: [matches.ts:38](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L38) +Defined in: [matches.ts:38](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L38) diff --git a/docs/reference/interfaces/keyboardkey.md b/docs/reference/interfaces/keyboardkey.md index de3eed2..51ed3e7 100644 --- a/docs/reference/interfaces/keyboardkey.md +++ b/docs/reference/interfaces/keyboardkey.md @@ -7,7 +7,7 @@ title: keyboardKey # Interface: keyboardKey -Defined in: [user-event/keyboard/types.ts:8](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L8) +Defined in: [user-event/keyboard/types.ts:8](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L8) ## Properties @@ -17,7 +17,7 @@ Defined in: [user-event/keyboard/types.ts:8](https://github.com/Romulad/cli-test optional code: string; ``` -Defined in: [user-event/keyboard/types.ts:10](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L10) +Defined in: [user-event/keyboard/types.ts:10](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L10) Physical location on a keyboard @@ -29,6 +29,6 @@ Physical location on a keyboard optional hex: string; ``` -Defined in: [user-event/keyboard/types.ts:12](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L12) +Defined in: [user-event/keyboard/types.ts:12](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/user-event/keyboard/types.ts#L12) Character or functional key hex code diff --git a/docs/reference/interfaces/matcheroptions.md b/docs/reference/interfaces/matcheroptions.md index db8474e..16e4141 100644 --- a/docs/reference/interfaces/matcheroptions.md +++ b/docs/reference/interfaces/matcheroptions.md @@ -7,7 +7,7 @@ title: MatcherOptions # Interface: MatcherOptions -Defined in: [matches.ts:17](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L17) +Defined in: [matches.ts:17](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L17) ## Extended by @@ -21,7 +21,7 @@ Defined in: [matches.ts:17](https://github.com/Romulad/cli-testing-library/blob/ optional collapseWhitespace: boolean; ``` -Defined in: [matches.ts:24](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L24) +Defined in: [matches.ts:24](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L24) Use normalizer with getDefaultNormalizer instead @@ -33,7 +33,7 @@ Use normalizer with getDefaultNormalizer instead optional exact: boolean; ``` -Defined in: [matches.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L18) +Defined in: [matches.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L18) *** @@ -43,7 +43,7 @@ Defined in: [matches.ts:18](https://github.com/Romulad/cli-testing-library/blob/ optional normalizer: NormalizerFn; ``` -Defined in: [matches.ts:25](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L25) +Defined in: [matches.ts:25](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L25) *** @@ -53,7 +53,7 @@ Defined in: [matches.ts:25](https://github.com/Romulad/cli-testing-library/blob/ optional stripAnsi: boolean; ``` -Defined in: [matches.ts:22](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L22) +Defined in: [matches.ts:22](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L22) Use normalizer with getDefaultNormalizer instead @@ -65,7 +65,7 @@ Use normalizer with getDefaultNormalizer instead optional suggest: boolean; ``` -Defined in: [matches.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L27) +Defined in: [matches.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L27) suppress suggestions for a specific query @@ -77,6 +77,6 @@ suppress suggestions for a specific query optional trim: boolean; ``` -Defined in: [matches.ts:20](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L20) +Defined in: [matches.ts:20](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L20) Use normalizer with getDefaultNormalizer instead diff --git a/docs/reference/interfaces/normalizeroptions.md b/docs/reference/interfaces/normalizeroptions.md index b04479f..ea4d267 100644 --- a/docs/reference/interfaces/normalizeroptions.md +++ b/docs/reference/interfaces/normalizeroptions.md @@ -7,7 +7,7 @@ title: NormalizerOptions # Interface: NormalizerOptions -Defined in: [matches.ts:13](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L13) +Defined in: [matches.ts:13](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L13) ## Extends @@ -21,7 +21,7 @@ Defined in: [matches.ts:13](https://github.com/Romulad/cli-testing-library/blob/ optional collapseWhitespace: boolean; ``` -Defined in: [matches.ts:39](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L39) +Defined in: [matches.ts:39](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L39) #### Inherited from @@ -35,7 +35,7 @@ Defined in: [matches.ts:39](https://github.com/Romulad/cli-testing-library/blob/ optional normalizer: NormalizerFn; ``` -Defined in: [matches.ts:14](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L14) +Defined in: [matches.ts:14](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L14) *** @@ -45,7 +45,7 @@ Defined in: [matches.ts:14](https://github.com/Romulad/cli-testing-library/blob/ optional stripAnsi: boolean; ``` -Defined in: [matches.ts:40](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L40) +Defined in: [matches.ts:40](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L40) #### Inherited from @@ -59,7 +59,7 @@ Defined in: [matches.ts:40](https://github.com/Romulad/cli-testing-library/blob/ optional trim: boolean; ``` -Defined in: [matches.ts:38](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L38) +Defined in: [matches.ts:38](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L38) #### Inherited from diff --git a/docs/reference/interfaces/queries.md b/docs/reference/interfaces/queries.md index 18b7cb2..fd33e3b 100644 --- a/docs/reference/interfaces/queries.md +++ b/docs/reference/interfaces/queries.md @@ -7,7 +7,7 @@ title: Queries # Interface: Queries -Defined in: [get-queries-for-instance.ts:40](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L40) +Defined in: [get-queries-for-instance.ts:40](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L40) ## Indexable diff --git a/docs/reference/interfaces/renderoptions.md b/docs/reference/interfaces/renderoptions.md index 718c42f..8b4e88a 100644 --- a/docs/reference/interfaces/renderoptions.md +++ b/docs/reference/interfaces/renderoptions.md @@ -7,7 +7,7 @@ title: RenderOptions # Interface: RenderOptions -Defined in: [pure.ts:24](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L24) +Defined in: [pure.ts:24](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L24) ## Properties @@ -17,7 +17,7 @@ Defined in: [pure.ts:24](https://github.com/Romulad/cli-testing-library/blob/mai cwd: string; ``` -Defined in: [pure.ts:25](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L25) +Defined in: [pure.ts:25](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L25) *** @@ -27,7 +27,7 @@ Defined in: [pure.ts:25](https://github.com/Romulad/cli-testing-library/blob/mai debug: boolean; ``` -Defined in: [pure.ts:26](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L26) +Defined in: [pure.ts:26](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L26) *** @@ -37,4 +37,4 @@ Defined in: [pure.ts:26](https://github.com/Romulad/cli-testing-library/blob/mai spawnOpts: Omit; ``` -Defined in: [pure.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L27) +Defined in: [pure.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L27) diff --git a/docs/reference/interfaces/selectormatcheroptions.md b/docs/reference/interfaces/selectormatcheroptions.md index e33fe60..82fe404 100644 --- a/docs/reference/interfaces/selectormatcheroptions.md +++ b/docs/reference/interfaces/selectormatcheroptions.md @@ -7,7 +7,7 @@ title: SelectorMatcherOptions # Interface: SelectorMatcherOptions -Defined in: [query-helpers.ts:16](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L16) +Defined in: [query-helpers.ts:16](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L16) ## Extends @@ -21,7 +21,7 @@ Defined in: [query-helpers.ts:16](https://github.com/Romulad/cli-testing-library optional collapseWhitespace: boolean; ``` -Defined in: [matches.ts:24](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L24) +Defined in: [matches.ts:24](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L24) Use normalizer with getDefaultNormalizer instead @@ -37,7 +37,7 @@ Use normalizer with getDefaultNormalizer instead optional exact: boolean; ``` -Defined in: [matches.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L18) +Defined in: [matches.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L18) #### Inherited from @@ -51,7 +51,7 @@ Defined in: [matches.ts:18](https://github.com/Romulad/cli-testing-library/blob/ optional ignore: string | boolean; ``` -Defined in: [query-helpers.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L18) +Defined in: [query-helpers.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L18) *** @@ -61,7 +61,7 @@ Defined in: [query-helpers.ts:18](https://github.com/Romulad/cli-testing-library optional normalizer: NormalizerFn; ``` -Defined in: [matches.ts:25](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L25) +Defined in: [matches.ts:25](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L25) #### Inherited from @@ -75,7 +75,7 @@ Defined in: [matches.ts:25](https://github.com/Romulad/cli-testing-library/blob/ optional selector: string; ``` -Defined in: [query-helpers.ts:17](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L17) +Defined in: [query-helpers.ts:17](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L17) *** @@ -85,7 +85,7 @@ Defined in: [query-helpers.ts:17](https://github.com/Romulad/cli-testing-library optional stripAnsi: boolean; ``` -Defined in: [matches.ts:22](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L22) +Defined in: [matches.ts:22](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L22) Use normalizer with getDefaultNormalizer instead @@ -101,7 +101,7 @@ Use normalizer with getDefaultNormalizer instead optional suggest: boolean; ``` -Defined in: [matches.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L27) +Defined in: [matches.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L27) suppress suggestions for a specific query @@ -117,7 +117,7 @@ suppress suggestions for a specific query optional trim: boolean; ``` -Defined in: [matches.ts:20](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L20) +Defined in: [matches.ts:20](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L20) Use normalizer with getDefaultNormalizer instead diff --git a/docs/reference/interfaces/waitforoptions.md b/docs/reference/interfaces/waitforoptions.md index c6b6005..f90cce4 100644 --- a/docs/reference/interfaces/waitforoptions.md +++ b/docs/reference/interfaces/waitforoptions.md @@ -7,7 +7,7 @@ title: waitForOptions # Interface: waitForOptions -Defined in: [wait-for.ts:14](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L14) +Defined in: [wait-for.ts:14](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L14) ## Properties @@ -17,7 +17,7 @@ Defined in: [wait-for.ts:14](https://github.com/Romulad/cli-testing-library/blob optional instance: TestInstance; ``` -Defined in: [wait-for.ts:15](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L15) +Defined in: [wait-for.ts:15](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L15) *** @@ -27,7 +27,7 @@ Defined in: [wait-for.ts:15](https://github.com/Romulad/cli-testing-library/blob optional interval: number; ``` -Defined in: [wait-for.ts:18](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L18) +Defined in: [wait-for.ts:18](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L18) *** @@ -37,7 +37,7 @@ Defined in: [wait-for.ts:18](https://github.com/Romulad/cli-testing-library/blob optional onTimeout: (error) => Error; ``` -Defined in: [wait-for.ts:19](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L19) +Defined in: [wait-for.ts:19](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L19) #### Parameters @@ -57,7 +57,7 @@ Defined in: [wait-for.ts:19](https://github.com/Romulad/cli-testing-library/blob optional showOriginalStackTrace: boolean; ``` -Defined in: [wait-for.ts:16](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L16) +Defined in: [wait-for.ts:16](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L16) *** @@ -67,7 +67,7 @@ Defined in: [wait-for.ts:16](https://github.com/Romulad/cli-testing-library/blob optional stackTraceError: Error; ``` -Defined in: [wait-for.ts:20](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L20) +Defined in: [wait-for.ts:20](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L20) *** @@ -77,4 +77,4 @@ Defined in: [wait-for.ts:20](https://github.com/Romulad/cli-testing-library/blob optional timeout: number; ``` -Defined in: [wait-for.ts:17](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L17) +Defined in: [wait-for.ts:17](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/wait-for.ts#L17) diff --git a/docs/reference/namespaces/queries/functions/findbyerror.md b/docs/reference/namespaces/queries/functions/findbyerror.md index f27b651..deada4b 100644 --- a/docs/reference/namespaces/queries/functions/findbyerror.md +++ b/docs/reference/namespaces/queries/functions/findbyerror.md @@ -11,7 +11,7 @@ title: findByError function findByError(...args): ReturnType> ``` -Defined in: [queries/error.ts:71](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L71) +Defined in: [queries/error.ts:71](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L71) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/findbytext.md b/docs/reference/namespaces/queries/functions/findbytext.md index a205ec2..06ac6b8 100644 --- a/docs/reference/namespaces/queries/functions/findbytext.md +++ b/docs/reference/namespaces/queries/functions/findbytext.md @@ -11,7 +11,7 @@ title: findByText function findByText(...args): ReturnType> ``` -Defined in: [queries/text.ts:69](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L69) +Defined in: [queries/text.ts:69](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L69) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/getbyerror.md b/docs/reference/namespaces/queries/functions/getbyerror.md index df68485..084c41f 100644 --- a/docs/reference/namespaces/queries/functions/getbyerror.md +++ b/docs/reference/namespaces/queries/functions/getbyerror.md @@ -11,7 +11,7 @@ title: getByError function getByError(...args): ReturnType> ``` -Defined in: [queries/error.ts:59](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L59) +Defined in: [queries/error.ts:59](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L59) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/getbytext.md b/docs/reference/namespaces/queries/functions/getbytext.md index d208e1c..0b648df 100644 --- a/docs/reference/namespaces/queries/functions/getbytext.md +++ b/docs/reference/namespaces/queries/functions/getbytext.md @@ -11,7 +11,7 @@ title: getByText function getByText(...args): ReturnType> ``` -Defined in: [queries/text.ts:59](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L59) +Defined in: [queries/text.ts:59](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L59) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/querybyerror.md b/docs/reference/namespaces/queries/functions/querybyerror.md index 89dc288..409756a 100644 --- a/docs/reference/namespaces/queries/functions/querybyerror.md +++ b/docs/reference/namespaces/queries/functions/querybyerror.md @@ -11,7 +11,7 @@ title: queryByError function queryByError(...args): ReturnType> ``` -Defined in: [queries/error.ts:65](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L65) +Defined in: [queries/error.ts:65](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L65) ## Type Parameters diff --git a/docs/reference/namespaces/queries/functions/querybytext.md b/docs/reference/namespaces/queries/functions/querybytext.md index 695c282..28440e0 100644 --- a/docs/reference/namespaces/queries/functions/querybytext.md +++ b/docs/reference/namespaces/queries/functions/querybytext.md @@ -11,7 +11,7 @@ title: queryByText function queryByText(...args): ReturnType> ``` -Defined in: [queries/text.ts:64](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L64) +Defined in: [queries/text.ts:64](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L64) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/findbyerror.md b/docs/reference/namespaces/queries/type-aliases/findbyerror.md index ead4646..0f4abb9 100644 --- a/docs/reference/namespaces/queries/type-aliases/findbyerror.md +++ b/docs/reference/namespaces/queries/type-aliases/findbyerror.md @@ -11,7 +11,7 @@ title: FindByError type FindByError = (instance, id, options?, waitForElementOptions?) => Promise; ``` -Defined in: [queries/error.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L27) +Defined in: [queries/error.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L27) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/findbytext.md b/docs/reference/namespaces/queries/type-aliases/findbytext.md index fe85823..76b9ba8 100644 --- a/docs/reference/namespaces/queries/type-aliases/findbytext.md +++ b/docs/reference/namespaces/queries/type-aliases/findbytext.md @@ -11,7 +11,7 @@ title: FindByText type FindByText = (instance, id, options?, waitForElementOptions?) => Promise; ``` -Defined in: [queries/text.ts:27](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L27) +Defined in: [queries/text.ts:27](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L27) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/getbyerror.md b/docs/reference/namespaces/queries/type-aliases/getbyerror.md index cab261c..434aa8b 100644 --- a/docs/reference/namespaces/queries/type-aliases/getbyerror.md +++ b/docs/reference/namespaces/queries/type-aliases/getbyerror.md @@ -11,7 +11,7 @@ title: GetByError type GetByError = (instance, id, options?) => T; ``` -Defined in: [queries/error.ts:21](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L21) +Defined in: [queries/error.ts:21](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L21) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/getbytext.md b/docs/reference/namespaces/queries/type-aliases/getbytext.md index 904925b..3e4d0f2 100644 --- a/docs/reference/namespaces/queries/type-aliases/getbytext.md +++ b/docs/reference/namespaces/queries/type-aliases/getbytext.md @@ -11,7 +11,7 @@ title: GetByText type GetByText = (instance, id, options?) => T; ``` -Defined in: [queries/text.ts:21](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L21) +Defined in: [queries/text.ts:21](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L21) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/querybyerror.md b/docs/reference/namespaces/queries/type-aliases/querybyerror.md index 66c6e9a..80d593a 100644 --- a/docs/reference/namespaces/queries/type-aliases/querybyerror.md +++ b/docs/reference/namespaces/queries/type-aliases/querybyerror.md @@ -11,7 +11,7 @@ title: QueryByError type QueryByError = (instance, id, options?) => T | null; ``` -Defined in: [queries/error.ts:15](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L15) +Defined in: [queries/error.ts:15](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/error.ts#L15) ## Type Parameters diff --git a/docs/reference/namespaces/queries/type-aliases/querybytext.md b/docs/reference/namespaces/queries/type-aliases/querybytext.md index 15452ee..4d51f8d 100644 --- a/docs/reference/namespaces/queries/type-aliases/querybytext.md +++ b/docs/reference/namespaces/queries/type-aliases/querybytext.md @@ -11,7 +11,7 @@ title: QueryByText type QueryByText = (instance, id, options?) => T | null; ``` -Defined in: [queries/text.ts:15](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L15) +Defined in: [queries/text.ts:15](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/queries/text.ts#L15) ## Type Parameters diff --git a/docs/reference/type-aliases/boundfunction.md b/docs/reference/type-aliases/boundfunction.md index 69474a9..9fa91de 100644 --- a/docs/reference/type-aliases/boundfunction.md +++ b/docs/reference/type-aliases/boundfunction.md @@ -11,7 +11,7 @@ title: BoundFunction type BoundFunction = T extends (container, ...args) => infer R ? (...args) => R : never; ``` -Defined in: [get-queries-for-instance.ts:4](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L4) +Defined in: [get-queries-for-instance.ts:4](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L4) ## Type Parameters diff --git a/docs/reference/type-aliases/boundfunctions.md b/docs/reference/type-aliases/boundfunctions.md index b0987e1..177271f 100644 --- a/docs/reference/type-aliases/boundfunctions.md +++ b/docs/reference/type-aliases/boundfunctions.md @@ -11,7 +11,7 @@ title: BoundFunctions type BoundFunctions = TQueries extends typeof queries ? object & { [P in keyof TQueries]: BoundFunction } : { [P in keyof TQueries]: BoundFunction }; ``` -Defined in: [get-queries-for-instance.ts:11](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L11) +Defined in: [get-queries-for-instance.ts:11](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L11) ## Type Parameters diff --git a/docs/reference/type-aliases/eventtype.md b/docs/reference/type-aliases/eventtype.md index d0fca31..97e2b2e 100644 --- a/docs/reference/type-aliases/eventtype.md +++ b/docs/reference/type-aliases/eventtype.md @@ -11,4 +11,4 @@ title: EventType type EventType = keyof EventMap; ``` -Defined in: [events.ts:5](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L5) +Defined in: [events.ts:5](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L5) diff --git a/docs/reference/type-aliases/firefunction.md b/docs/reference/type-aliases/firefunction.md index 9aab7cf..34678d4 100644 --- a/docs/reference/type-aliases/firefunction.md +++ b/docs/reference/type-aliases/firefunction.md @@ -11,7 +11,7 @@ title: FireFunction type FireFunction = (instance, event, options?) => boolean | Promise; ``` -Defined in: [events.ts:7](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L7) +Defined in: [events.ts:7](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L7) ## Type Parameters diff --git a/docs/reference/type-aliases/fireobject.md b/docs/reference/type-aliases/fireobject.md index f9582b1..98fd944 100644 --- a/docs/reference/type-aliases/fireobject.md +++ b/docs/reference/type-aliases/fireobject.md @@ -11,4 +11,4 @@ title: FireObject type FireObject = { [K in EventType]: (instance: TestInstance, options?: Parameters[1]) => boolean | Promise }; ``` -Defined in: [events.ts:13](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L13) +Defined in: [events.ts:13](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/events.ts#L13) diff --git a/docs/reference/type-aliases/geterrorfunction.md b/docs/reference/type-aliases/geterrorfunction.md index 137c358..4b6626a 100644 --- a/docs/reference/type-aliases/geterrorfunction.md +++ b/docs/reference/type-aliases/geterrorfunction.md @@ -11,7 +11,7 @@ title: GetErrorFunction type GetErrorFunction = (c, ...args) => string; ``` -Defined in: [query-helpers.ts:11](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L11) +Defined in: [query-helpers.ts:11](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L11) ## Type Parameters diff --git a/docs/reference/type-aliases/match.md b/docs/reference/type-aliases/match.md index 1302ed3..3271237 100644 --- a/docs/reference/type-aliases/match.md +++ b/docs/reference/type-aliases/match.md @@ -11,7 +11,7 @@ title: Match type Match = (textToMatch, node, matcher, options?) => boolean; ``` -Defined in: [matches.ts:30](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L30) +Defined in: [matches.ts:30](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L30) ## Parameters diff --git a/docs/reference/type-aliases/matcher.md b/docs/reference/type-aliases/matcher.md index 3c8a4ac..4fff396 100644 --- a/docs/reference/type-aliases/matcher.md +++ b/docs/reference/type-aliases/matcher.md @@ -11,4 +11,4 @@ title: Matcher type Matcher = MatcherFunction | RegExp | number | string; ``` -Defined in: [matches.ts:9](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L9) +Defined in: [matches.ts:9](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L9) diff --git a/docs/reference/type-aliases/matcherfunction.md b/docs/reference/type-aliases/matcherfunction.md index c0c4362..828139f 100644 --- a/docs/reference/type-aliases/matcherfunction.md +++ b/docs/reference/type-aliases/matcherfunction.md @@ -11,7 +11,7 @@ title: MatcherFunction type MatcherFunction = (content, element) => boolean; ``` -Defined in: [matches.ts:4](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L4) +Defined in: [matches.ts:4](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L4) ## Parameters diff --git a/docs/reference/type-aliases/normalizerfn.md b/docs/reference/type-aliases/normalizerfn.md index 7461c34..cf5e34e 100644 --- a/docs/reference/type-aliases/normalizerfn.md +++ b/docs/reference/type-aliases/normalizerfn.md @@ -11,7 +11,7 @@ title: NormalizerFn type NormalizerFn = (text) => string; ``` -Defined in: [matches.ts:11](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L11) +Defined in: [matches.ts:11](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/matches.ts#L11) ## Parameters diff --git a/docs/reference/type-aliases/query.md b/docs/reference/type-aliases/query.md index 82a06a9..7353892 100644 --- a/docs/reference/type-aliases/query.md +++ b/docs/reference/type-aliases/query.md @@ -17,7 +17,7 @@ type Query = (container, ...args) => | null; ``` -Defined in: [get-queries-for-instance.ts:29](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L29) +Defined in: [get-queries-for-instance.ts:29](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/get-queries-for-instance.ts#L29) ## Parameters diff --git a/docs/reference/type-aliases/querymethod.md b/docs/reference/type-aliases/querymethod.md index a9202af..25f0906 100644 --- a/docs/reference/type-aliases/querymethod.md +++ b/docs/reference/type-aliases/querymethod.md @@ -11,7 +11,7 @@ title: QueryMethod type QueryMethod = (container, ...args) => TReturn; ``` -Defined in: [query-helpers.ts:21](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L21) +Defined in: [query-helpers.ts:21](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L21) ## Type Parameters diff --git a/docs/reference/type-aliases/renderresult.md b/docs/reference/type-aliases/renderresult.md index e89dde4..51c6836 100644 --- a/docs/reference/type-aliases/renderresult.md +++ b/docs/reference/type-aliases/renderresult.md @@ -11,7 +11,7 @@ title: RenderResult type RenderResult = TestInstance & object & { [P in keyof typeof queries]: BoundFunction }; ``` -Defined in: [pure.ts:32](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L32) +Defined in: [pure.ts:32](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/pure.ts#L32) ## Type declaration diff --git a/docs/reference/type-aliases/withsuggest.md b/docs/reference/type-aliases/withsuggest.md index cb28636..f096a97 100644 --- a/docs/reference/type-aliases/withsuggest.md +++ b/docs/reference/type-aliases/withsuggest.md @@ -11,7 +11,7 @@ title: WithSuggest type WithSuggest = object; ``` -Defined in: [query-helpers.ts:9](https://github.com/Romulad/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L9) +Defined in: [query-helpers.ts:9](https://github.com/crutchcorn/cli-testing-library/blob/main/packages/cli-testing-library/src/query-helpers.ts#L9) ## Type declaration