diff --git a/automation/source-repo-templates/api-docs.rust.yml b/automation/source-repo-templates/api-docs.rust.yml index 74778d4a..27096bb5 100644 --- a/automation/source-repo-templates/api-docs.rust.yml +++ b/automation/source-repo-templates/api-docs.rust.yml @@ -407,6 +407,44 @@ jobs: f.write_text(new, encoding="utf-8") PY + - name: Strip .md extension from internal link targets + # Mintlify routes URLs without the `.md` extension. A + # markdown link like `[label](./foo.md)` is treated as a + # literal path that 404s in the rendered site, even when + # the target file exists. Drop `.md` (and collapse + # `/index.md` to its parent dir form) so links resolve + # natively. cargo-doc-md generally uses in-page anchors, + # not file links, but README content embedded into landing + # pages routinely carries `.md` suffixes. + working-directory: ${{ env.OUTPUT_DIR }} + run: | + python3 - <<'PY' + import pathlib + import re + + link_re = re.compile(r'(? str: + first_seg = target.split("/", 1)[0] + if ":" in first_seg: + return target + path, _, frag = target.partition("#") + frag = ("#" + frag) if frag else "" + if path.endswith("/index.md"): + path = path[: -len("/index.md")] or "." + elif path.endswith(".md"): + path = path[:-3] + return path + frag + + for f in pathlib.Path(".").rglob("*.md"): + text = f.read_text(encoding="utf-8") + def fix(m: re.Match) -> str: + return f"[{m.group(1)}]({strip_md(m.group(2))})" + new = link_re.sub(fix, text) + if new != text: + f.write_text(new, encoding="utf-8") + PY + - name: Escape MDX-special characters outside code regions # Mintlify parses .md as MDX. Literal `{ ... }` in prose is # interpreted as a JSX expression; literal `` (e.g. diff --git a/automation/source-repo-templates/api-docs.typescript.yml b/automation/source-repo-templates/api-docs.typescript.yml index a3d857ac..ef6cc7ee 100644 --- a/automation/source-repo-templates/api-docs.typescript.yml +++ b/automation/source-repo-templates/api-docs.typescript.yml @@ -285,6 +285,48 @@ jobs: f.write_text(new, encoding="utf-8") PY + - name: Strip .md extension from internal link targets + # Mintlify routes URLs without the `.md` extension; a + # markdown link like `[label](./foo.md)` is treated as a + # literal path that 404s in the rendered site, even when + # `./foo.md` exists on disk. + # + # `[label](dir/index.md)` collapses to `[label](dir)` so it + # matches the splice's strip-/index registration (the parent + # path resolves to the dir's index landing natively). Plain + # `.md` leaves get the extension dropped; fragments are + # preserved. URL-scheme targets (http://, mailto:, data:) + # are left alone. + working-directory: ${{ env.OUTPUT_DIR }} + run: | + python3 - <<'PY' + import pathlib + import re + + link_re = re.compile(r'(? str: + first_seg = target.split("/", 1)[0] + if ":" in first_seg: + return target + path, _, frag = target.partition("#") + frag = ("#" + frag) if frag else "" + if path.endswith("/index.md"): + path = path[: -len("/index.md")] or "." + elif path.endswith(".md"): + path = path[:-3] + return path + frag + + for f in pathlib.Path(".").rglob("*.md"): + text = f.read_text(encoding="utf-8") + def fix(m: re.Match) -> str: + label, target = m.group(1), m.group(2) + return f"[{label}]({strip_md(target)})" + new = link_re.sub(fix, text) + if new != text: + f.write_text(new, encoding="utf-8") + PY + - name: Strip TypeDoc breadcrumb header # Every typedoc-plugin-markdown page begins with a breadcrumb # block that links to ../../README.md and similar paths. diff --git a/sdks/typescript/api/analytics/index.md b/sdks/typescript/api/analytics/index.md index 1be371d5..acbea1fd 100644 --- a/sdks/typescript/api/analytics/index.md +++ b/sdks/typescript/api/analytics/index.md @@ -2,7 +2,7 @@ ## Modules -- [index](./index/index.md) -- [next](./next/index.md) -- [react](./react/index.md) -- [resq](./resq/index.md) +- [index](./index) +- [next](./next) +- [react](./react) +- [resq](./resq) diff --git a/sdks/typescript/api/analytics/index/classes/Analytics.md b/sdks/typescript/api/analytics/index/classes/Analytics.md index 6592efe9..42f584be 100644 --- a/sdks/typescript/api/analytics/index/classes/Analytics.md +++ b/sdks/typescript/api/analytics/index/classes/Analytics.md @@ -18,13 +18,13 @@ Defined in: [index.ts:111](https://github.com/resq-software/npm/blob/f2ab5fc82f4 #### Get Signature -> **get** **config**(): `Readonly`\<[`AnalyticsConfig`](../interfaces/AnalyticsConfig.md)\> \| `null` +> **get** **config**(): `Readonly`\<[`AnalyticsConfig`](../interfaces/AnalyticsConfig)\> \| `null` Defined in: [index.ts:116](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L116) ##### Returns -`Readonly`\<[`AnalyticsConfig`](../interfaces/AnalyticsConfig.md)\> \| `null` +`Readonly`\<[`AnalyticsConfig`](../interfaces/AnalyticsConfig)\> \| `null` *** @@ -74,7 +74,7 @@ Defined in: [index.ts:124](https://github.com/resq-software/npm/blob/f2ab5fc82f4 ##### config -[`AnalyticsConfig`](../interfaces/AnalyticsConfig.md) +[`AnalyticsConfig`](../interfaces/AnalyticsConfig) #### Returns @@ -138,7 +138,7 @@ Defined in: [index.ts:166](https://github.com/resq-software/npm/blob/f2ab5fc82f4 ##### properties? -`E` *extends* `string` \| `number` ? [`AnalyticsEvents`](../interfaces/AnalyticsEvents.md)\[`E`\] : `Record`\<`string`, `unknown`\> +`E` *extends* `string` \| `number` ? [`AnalyticsEvents`](../interfaces/AnalyticsEvents)\[`E`\] : `Record`\<`string`, `unknown`\> #### Returns diff --git a/sdks/typescript/api/analytics/index/functions/initAnalytics.md b/sdks/typescript/api/analytics/index/functions/initAnalytics.md index ab0f7a47..326106f8 100644 --- a/sdks/typescript/api/analytics/index/functions/initAnalytics.md +++ b/sdks/typescript/api/analytics/index/functions/initAnalytics.md @@ -8,7 +8,7 @@ Defined in: [index.ts:222](https://github.com/resq-software/npm/blob/f2ab5fc82f4 ### config -[`AnalyticsConfig`](../interfaces/AnalyticsConfig.md) +[`AnalyticsConfig`](../interfaces/AnalyticsConfig) ## Returns diff --git a/sdks/typescript/api/analytics/index/index.md b/sdks/typescript/api/analytics/index/index.md index 46b74608..8d049a51 100644 --- a/sdks/typescript/api/analytics/index/index.md +++ b/sdks/typescript/api/analytics/index/index.md @@ -2,48 +2,48 @@ ## Classes -- [Analytics](./classes/Analytics.md) +- [Analytics](./classes/Analytics) ## Interfaces -- [AnalyticsConfig](./interfaces/AnalyticsConfig.md) -- [AnalyticsEvents](./interfaces/AnalyticsEvents.md) -- [GA4ProviderConfig](./interfaces/GA4ProviderConfig.md) -- [PostHogProviderConfig](./interfaces/PostHogProviderConfig.md) +- [AnalyticsConfig](./interfaces/AnalyticsConfig) +- [AnalyticsEvents](./interfaces/AnalyticsEvents) +- [GA4ProviderConfig](./interfaces/GA4ProviderConfig) +- [PostHogProviderConfig](./interfaces/PostHogProviderConfig) ## Variables -- [analytics](./variables/analytics.md) -- [track](./variables/track.md) +- [analytics](./variables/analytics) +- [track](./variables/track) ## Functions -- [identify](./functions/identify.md) -- [inferCookieDomain](./functions/inferCookieDomain.md) -- [initAnalytics](./functions/initAnalytics.md) -- [pageview](./functions/pageview.md) -- [reset](./functions/reset.md) +- [identify](./functions/identify) +- [inferCookieDomain](./functions/inferCookieDomain) +- [initAnalytics](./functions/initAnalytics) +- [pageview](./functions/pageview) +- [reset](./functions/reset) ## References ### GA4\_ID\_PATTERN -Re-exports [GA4_ID_PATTERN](../resq/variables/GA4_ID_PATTERN.md) +Re-exports [GA4_ID_PATTERN](../resq/variables/GA4_ID_PATTERN) *** ### resolveResqCookieDomain -Re-exports [resolveResqCookieDomain](../resq/functions/resolveResqCookieDomain.md) +Re-exports [resolveResqCookieDomain](../resq/functions/resolveResqCookieDomain) *** ### RESQ\_SUBDOMAIN\_ALLOWLIST -Re-exports [RESQ_SUBDOMAIN_ALLOWLIST](../resq/variables/RESQ_SUBDOMAIN_ALLOWLIST.md) +Re-exports [RESQ_SUBDOMAIN_ALLOWLIST](../resq/variables/RESQ_SUBDOMAIN_ALLOWLIST) *** ### sanitizeGa4Id -Re-exports [sanitizeGa4Id](../resq/functions/sanitizeGa4Id.md) +Re-exports [sanitizeGa4Id](../resq/functions/sanitizeGa4Id) diff --git a/sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig.md b/sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig.md index 19f06bb6..a1349eba 100644 --- a/sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig.md +++ b/sdks/typescript/api/analytics/index/interfaces/AnalyticsConfig.md @@ -30,7 +30,7 @@ Defined in: [index.ts:54](https://github.com/resq-software/npm/blob/f2ab5fc82f4f ### ga4? -> `optional` **ga4?**: [`GA4ProviderConfig`](./GA4ProviderConfig.md) +> `optional` **ga4?**: [`GA4ProviderConfig`](./GA4ProviderConfig) Defined in: [index.ts:52](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L52) @@ -38,6 +38,6 @@ Defined in: [index.ts:52](https://github.com/resq-software/npm/blob/f2ab5fc82f4f ### posthog? -> `optional` **posthog?**: [`PostHogProviderConfig`](./PostHogProviderConfig.md) +> `optional` **posthog?**: [`PostHogProviderConfig`](./PostHogProviderConfig) Defined in: [index.ts:51](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L51) diff --git a/sdks/typescript/api/analytics/index/variables/analytics.md b/sdks/typescript/api/analytics/index/variables/analytics.md index fe5951c5..eeaae021 100644 --- a/sdks/typescript/api/analytics/index/variables/analytics.md +++ b/sdks/typescript/api/analytics/index/variables/analytics.md @@ -1,5 +1,5 @@ # Variable: analytics -> `const` **analytics**: [`Analytics`](../classes/Analytics.md) +> `const` **analytics**: [`Analytics`](../classes/Analytics) Defined in: [index.ts:220](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L220) diff --git a/sdks/typescript/api/analytics/index/variables/track.md b/sdks/typescript/api/analytics/index/variables/track.md index 661c8383..f2fde5c9 100644 --- a/sdks/typescript/api/analytics/index/variables/track.md +++ b/sdks/typescript/api/analytics/index/variables/track.md @@ -1,5 +1,5 @@ # Variable: track -> `const` **track**: [`Analytics`](../classes/Analytics.md)\[`"track"`\] +> `const` **track**: [`Analytics`](../classes/Analytics)\[`"track"`\] Defined in: [index.ts:224](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/index.ts#L224) diff --git a/sdks/typescript/api/analytics/next/functions/ga4Stream.md b/sdks/typescript/api/analytics/next/functions/ga4Stream.md index 2c5e9587..ddb7d407 100644 --- a/sdks/typescript/api/analytics/next/functions/ga4Stream.md +++ b/sdks/typescript/api/analytics/next/functions/ga4Stream.md @@ -1,6 +1,6 @@ # Function: ga4Stream() -> **ga4Stream**(`measurementId`, `domains?`): [`GA4ProviderConfig`](../../index/interfaces/GA4ProviderConfig.md) +> **ga4Stream**(`measurementId`, `domains?`): [`GA4ProviderConfig`](../../index/interfaces/GA4ProviderConfig) Defined in: [next/index.ts:74](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/next/index.ts#L74) @@ -16,4 +16,4 @@ Defined in: [next/index.ts:74](https://github.com/resq-software/npm/blob/f2ab5fc ## Returns -[`GA4ProviderConfig`](../../index/interfaces/GA4ProviderConfig.md) +[`GA4ProviderConfig`](../../index/interfaces/GA4ProviderConfig) diff --git a/sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites.md b/sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites.md index 36673f4c..77c9a285 100644 --- a/sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites.md +++ b/sdks/typescript/api/analytics/next/functions/withAnalyticsRewrites.md @@ -18,7 +18,7 @@ Defined in: [next/index.ts:41](https://github.com/resq-software/npm/blob/f2ab5fc ### options? -[`AnalyticsRewriteOptions`](../interfaces/AnalyticsRewriteOptions.md) = `{}` +[`AnalyticsRewriteOptions`](../interfaces/AnalyticsRewriteOptions) = `{}` ## Returns diff --git a/sdks/typescript/api/analytics/next/index.md b/sdks/typescript/api/analytics/next/index.md index c0cb32b6..4336b189 100644 --- a/sdks/typescript/api/analytics/next/index.md +++ b/sdks/typescript/api/analytics/next/index.md @@ -2,9 +2,9 @@ ## Interfaces -- [AnalyticsRewriteOptions](./interfaces/AnalyticsRewriteOptions.md) +- [AnalyticsRewriteOptions](./interfaces/AnalyticsRewriteOptions) ## Functions -- [ga4Stream](./functions/ga4Stream.md) -- [withAnalyticsRewrites](./functions/withAnalyticsRewrites.md) +- [ga4Stream](./functions/ga4Stream) +- [withAnalyticsRewrites](./functions/withAnalyticsRewrites) diff --git a/sdks/typescript/api/analytics/react/functions/AnalyticsProvider.md b/sdks/typescript/api/analytics/react/functions/AnalyticsProvider.md index 4dfc869f..bc45687d 100644 --- a/sdks/typescript/api/analytics/react/functions/AnalyticsProvider.md +++ b/sdks/typescript/api/analytics/react/functions/AnalyticsProvider.md @@ -8,7 +8,7 @@ Defined in: [react/index.ts:48](https://github.com/resq-software/npm/blob/f2ab5f ### \_\_namedParameters -[`AnalyticsProviderProps`](../interfaces/AnalyticsProviderProps.md) +[`AnalyticsProviderProps`](../interfaces/AnalyticsProviderProps) ## Returns diff --git a/sdks/typescript/api/analytics/react/functions/useAnalytics.md b/sdks/typescript/api/analytics/react/functions/useAnalytics.md index 90afa3fb..b424ea72 100644 --- a/sdks/typescript/api/analytics/react/functions/useAnalytics.md +++ b/sdks/typescript/api/analytics/react/functions/useAnalytics.md @@ -1,9 +1,9 @@ # Function: useAnalytics() -> **useAnalytics**(): [`UseAnalyticsReturn`](../interfaces/UseAnalyticsReturn.md) +> **useAnalytics**(): [`UseAnalyticsReturn`](../interfaces/UseAnalyticsReturn) Defined in: [react/index.ts:81](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L81) ## Returns -[`UseAnalyticsReturn`](../interfaces/UseAnalyticsReturn.md) +[`UseAnalyticsReturn`](../interfaces/UseAnalyticsReturn) diff --git a/sdks/typescript/api/analytics/react/index.md b/sdks/typescript/api/analytics/react/index.md index 32891b16..869e5a72 100644 --- a/sdks/typescript/api/analytics/react/index.md +++ b/sdks/typescript/api/analytics/react/index.md @@ -2,10 +2,10 @@ ## Interfaces -- [AnalyticsProviderProps](./interfaces/AnalyticsProviderProps.md) -- [UseAnalyticsReturn](./interfaces/UseAnalyticsReturn.md) +- [AnalyticsProviderProps](./interfaces/AnalyticsProviderProps) +- [UseAnalyticsReturn](./interfaces/UseAnalyticsReturn) ## Functions -- [AnalyticsProvider](./functions/AnalyticsProvider.md) -- [useAnalytics](./functions/useAnalytics.md) +- [AnalyticsProvider](./functions/AnalyticsProvider) +- [useAnalytics](./functions/useAnalytics) diff --git a/sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps.md b/sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps.md index b693c42d..cc9b9e22 100644 --- a/sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps.md +++ b/sdks/typescript/api/analytics/react/interfaces/AnalyticsProviderProps.md @@ -14,7 +14,7 @@ Defined in: [react/index.ts:33](https://github.com/resq-software/npm/blob/f2ab5f ### config -> **config**: [`AnalyticsConfig`](../../index/interfaces/AnalyticsConfig.md) +> **config**: [`AnalyticsConfig`](../../index/interfaces/AnalyticsConfig) Defined in: [react/index.ts:31](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L31) diff --git a/sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn.md b/sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn.md index 1b95e983..ac04bf36 100644 --- a/sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn.md +++ b/sdks/typescript/api/analytics/react/interfaces/UseAnalyticsReturn.md @@ -6,7 +6,7 @@ Defined in: [react/index.ts:73](https://github.com/resq-software/npm/blob/f2ab5f ### analytics -> **analytics**: [`Analytics`](../../index/classes/Analytics.md) +> **analytics**: [`Analytics`](../../index/classes/Analytics) Defined in: [react/index.ts:78](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/react/index.ts#L78) @@ -84,7 +84,7 @@ Defined in: [react/index.ts:74](https://github.com/resq-software/npm/blob/f2ab5f ##### properties? -`E` *extends* `string` \| `number` ? [`AnalyticsEvents`](../../index/interfaces/AnalyticsEvents.md)\[`E`\] : `Record`\<`string`, `unknown`\> +`E` *extends* `string` \| `number` ? [`AnalyticsEvents`](../../index/interfaces/AnalyticsEvents)\[`E`\] : `Record`\<`string`, `unknown`\> #### Returns diff --git a/sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id.md b/sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id.md index 7da2e5ad..6573f27e 100644 --- a/sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id.md +++ b/sdks/typescript/api/analytics/resq/functions/sanitizeGa4Id.md @@ -4,7 +4,7 @@ Defined in: [resq.ts:69](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/analytics/src/resq.ts#L69) -Validate a GA4 Measurement ID against [GA4\_ID\_PATTERN](../variables/GA4_ID_PATTERN.md). +Validate a GA4 Measurement ID against [GA4\_ID\_PATTERN](../variables/GA4_ID_PATTERN). ## Parameters diff --git a/sdks/typescript/api/analytics/resq/index.md b/sdks/typescript/api/analytics/resq/index.md index c90ed977..4678bdfa 100644 --- a/sdks/typescript/api/analytics/resq/index.md +++ b/sdks/typescript/api/analytics/resq/index.md @@ -2,10 +2,10 @@ ## Variables -- [GA4\_ID\_PATTERN](./variables/GA4_ID_PATTERN.md) -- [RESQ\_SUBDOMAIN\_ALLOWLIST](./variables/RESQ_SUBDOMAIN_ALLOWLIST.md) +- [GA4\_ID\_PATTERN](./variables/GA4_ID_PATTERN) +- [RESQ\_SUBDOMAIN\_ALLOWLIST](./variables/RESQ_SUBDOMAIN_ALLOWLIST) ## Functions -- [resolveResqCookieDomain](./functions/resolveResqCookieDomain.md) -- [sanitizeGa4Id](./functions/sanitizeGa4Id.md) +- [resolveResqCookieDomain](./functions/resolveResqCookieDomain) +- [sanitizeGa4Id](./functions/sanitizeGa4Id) diff --git a/sdks/typescript/api/decorators/after/after.fn/functions/afterFn.md b/sdks/typescript/api/decorators/after/after.fn/functions/afterFn.md index 0738e8b2..5dd6d250 100644 --- a/sdks/typescript/api/decorators/after/after.fn/functions/afterFn.md +++ b/sdks/typescript/api/decorators/after/after.fn/functions/afterFn.md @@ -24,13 +24,13 @@ The argument types of the original method ### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to wrap ### config -[`AfterConfig`](../../after.types/interfaces/AfterConfig.md)\<`any`, `D`\> +[`AfterConfig`](../../after.types/interfaces/AfterConfig)\<`any`, `D`\> Configuration for the after hook diff --git a/sdks/typescript/api/decorators/after/after.fn/index.md b/sdks/typescript/api/decorators/after/after.fn/index.md index 8ca3cfd8..7e1647c4 100644 --- a/sdks/typescript/api/decorators/after/after.fn/index.md +++ b/sdks/typescript/api/decorators/after/after.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [afterFn](./functions/afterFn.md) +- [afterFn](./functions/afterFn) diff --git a/sdks/typescript/api/decorators/after/after.types/index.md b/sdks/typescript/api/decorators/after/after.types/index.md index d78d0dde..e18fd074 100644 --- a/sdks/typescript/api/decorators/after/after.types/index.md +++ b/sdks/typescript/api/decorators/after/after.types/index.md @@ -2,9 +2,9 @@ ## Interfaces -- [AfterConfig](./interfaces/AfterConfig.md) -- [AfterParams](./interfaces/AfterParams.md) +- [AfterConfig](./interfaces/AfterConfig) +- [AfterParams](./interfaces/AfterParams) ## Type Aliases -- [AfterFunc](./type-aliases/AfterFunc.md) +- [AfterFunc](./type-aliases/AfterFunc) diff --git a/sdks/typescript/api/decorators/after/after.types/interfaces/AfterConfig.md b/sdks/typescript/api/decorators/after/after.types/interfaces/AfterConfig.md index d4b9eb0e..7a44f27f 100644 --- a/sdks/typescript/api/decorators/after/after.types/interfaces/AfterConfig.md +++ b/sdks/typescript/api/decorators/after/after.types/interfaces/AfterConfig.md @@ -44,7 +44,7 @@ The return type of the decorated method ### func -> **func**: [`AfterFunc`](../type-aliases/AfterFunc.md)\<`D`\> \| keyof `T` +> **func**: [`AfterFunc`](../type-aliases/AfterFunc)\<`D`\> \| keyof `T` Defined in: [after/after.types.ts:59](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/after/after.types.ts#L59) diff --git a/sdks/typescript/api/decorators/after/after.types/type-aliases/AfterFunc.md b/sdks/typescript/api/decorators/after/after.types/type-aliases/AfterFunc.md index d3260dce..6f4ad159 100644 --- a/sdks/typescript/api/decorators/after/after.types/type-aliases/AfterFunc.md +++ b/sdks/typescript/api/decorators/after/after.types/type-aliases/AfterFunc.md @@ -18,7 +18,7 @@ The return type of the decorated method ### x? -[`AfterParams`](../interfaces/AfterParams.md)\<`D`\> +[`AfterParams`](../interfaces/AfterParams)\<`D`\> Parameters containing args and response diff --git a/sdks/typescript/api/decorators/after/after/functions/after.md b/sdks/typescript/api/decorators/after/after/functions/after.md index b8e2f9f2..1af26431 100644 --- a/sdks/typescript/api/decorators/after/after/functions/after.md +++ b/sdks/typescript/api/decorators/after/after/functions/after.md @@ -1,6 +1,6 @@ # Function: after() -> **after**\<`T`, `D`\>(`config`): [`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +> **after**\<`T`, `D`\>(`config`): [`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> Defined in: [after/after.ts:74](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/after/after.ts#L74) @@ -25,13 +25,13 @@ The return type of the decorated method ### config -[`AfterConfig`](../../after.types/interfaces/AfterConfig.md)\<`T`, `D`\> +[`AfterConfig`](../../after.types/interfaces/AfterConfig)\<`T`, `D`\> Configuration for the after hook ## Returns -[`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +[`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> The decorator function diff --git a/sdks/typescript/api/decorators/after/after/index.md b/sdks/typescript/api/decorators/after/after/index.md index 00e281f2..453870de 100644 --- a/sdks/typescript/api/decorators/after/after/index.md +++ b/sdks/typescript/api/decorators/after/after/index.md @@ -2,4 +2,4 @@ ## Functions -- [after](./functions/after.md) +- [after](./functions/after) diff --git a/sdks/typescript/api/decorators/after/index.md b/sdks/typescript/api/decorators/after/index.md index 6d011fd3..be2fe834 100644 --- a/sdks/typescript/api/decorators/after/index.md +++ b/sdks/typescript/api/decorators/after/index.md @@ -4,22 +4,22 @@ ### after -Re-exports [after](./after/functions/after.md) +Re-exports [after](./after/functions/after) *** ### AfterConfig -Re-exports [AfterConfig](./after.types/interfaces/AfterConfig.md) +Re-exports [AfterConfig](./after.types/interfaces/AfterConfig) *** ### AfterFunc -Re-exports [AfterFunc](./after.types/type-aliases/AfterFunc.md) +Re-exports [AfterFunc](./after.types/type-aliases/AfterFunc) *** ### AfterParams -Re-exports [AfterParams](./after.types/interfaces/AfterParams.md) +Re-exports [AfterParams](./after.types/interfaces/AfterParams) diff --git a/sdks/typescript/api/decorators/before/before.fn/functions/beforeFn.md b/sdks/typescript/api/decorators/before/before.fn/functions/beforeFn.md index c898da24..1118ab2f 100644 --- a/sdks/typescript/api/decorators/before/before.fn/functions/beforeFn.md +++ b/sdks/typescript/api/decorators/before/before.fn/functions/beforeFn.md @@ -1,6 +1,6 @@ # Function: beforeFn() -> **beforeFn**\<`D`, `A`\>(`originalMethod`, `config`): [`Method`](../../../types/type-aliases/Method.md)\<`Promise`\<`D`\>, `A`\> +> **beforeFn**\<`D`, `A`\>(`originalMethod`, `config`): [`Method`](../../../types/type-aliases/Method)\<`Promise`\<`D`\>, `A`\> Defined in: [before/before.fn.ts:51](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/before/before.fn.ts#L51) @@ -24,19 +24,19 @@ The argument types of the original method ### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to wrap ### config -[`BeforeConfig`](../../before.types/interfaces/BeforeConfig.md)\<`any`\> +[`BeforeConfig`](../../before.types/interfaces/BeforeConfig)\<`any`\> Configuration for the before hook ## Returns -[`Method`](../../../types/type-aliases/Method.md)\<`Promise`\<`D`\>, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`Promise`\<`D`\>, `A`\> The wrapped method diff --git a/sdks/typescript/api/decorators/before/before.fn/index.md b/sdks/typescript/api/decorators/before/before.fn/index.md index 69fda73e..ea585f49 100644 --- a/sdks/typescript/api/decorators/before/before.fn/index.md +++ b/sdks/typescript/api/decorators/before/before.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [beforeFn](./functions/beforeFn.md) +- [beforeFn](./functions/beforeFn) diff --git a/sdks/typescript/api/decorators/before/before.types/index.md b/sdks/typescript/api/decorators/before/before.types/index.md index e284948e..e054d556 100644 --- a/sdks/typescript/api/decorators/before/before.types/index.md +++ b/sdks/typescript/api/decorators/before/before.types/index.md @@ -2,4 +2,4 @@ ## Interfaces -- [BeforeConfig](./interfaces/BeforeConfig.md) +- [BeforeConfig](./interfaces/BeforeConfig) diff --git a/sdks/typescript/api/decorators/before/before/functions/before.md b/sdks/typescript/api/decorators/before/before/functions/before.md index 0db768b3..cbd91bbf 100644 --- a/sdks/typescript/api/decorators/before/before/functions/before.md +++ b/sdks/typescript/api/decorators/before/before/functions/before.md @@ -1,6 +1,6 @@ # Function: before() -> **before**\<`T`\>(`config`): [`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +> **before**\<`T`\>(`config`): [`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> Defined in: [before/before.ts:75](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/before/before.ts#L75) @@ -19,13 +19,13 @@ The type of the class containing the decorated method ### config -[`BeforeConfig`](../../before.types/interfaces/BeforeConfig.md)\<`T`\> +[`BeforeConfig`](../../before.types/interfaces/BeforeConfig)\<`T`\> Configuration for the before hook ## Returns -[`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +[`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> The decorator function diff --git a/sdks/typescript/api/decorators/before/before/index.md b/sdks/typescript/api/decorators/before/before/index.md index 909ed34b..fc0e08f5 100644 --- a/sdks/typescript/api/decorators/before/before/index.md +++ b/sdks/typescript/api/decorators/before/before/index.md @@ -2,4 +2,4 @@ ## Functions -- [before](./functions/before.md) +- [before](./functions/before) diff --git a/sdks/typescript/api/decorators/before/index.md b/sdks/typescript/api/decorators/before/index.md index 65c90ac1..3a06247d 100644 --- a/sdks/typescript/api/decorators/before/index.md +++ b/sdks/typescript/api/decorators/before/index.md @@ -4,10 +4,10 @@ ### before -Re-exports [before](./before/functions/before.md) +Re-exports [before](./before/functions/before) *** ### BeforeConfig -Re-exports [BeforeConfig](./before.types/interfaces/BeforeConfig.md) +Re-exports [BeforeConfig](./before.types/interfaces/BeforeConfig) diff --git a/sdks/typescript/api/decorators/bind/bind.fn/functions/bindFn.md b/sdks/typescript/api/decorators/bind/bind.fn/functions/bindFn.md index 0608c839..cc02048a 100644 --- a/sdks/typescript/api/decorators/bind/bind.fn/functions/bindFn.md +++ b/sdks/typescript/api/decorators/bind/bind.fn/functions/bindFn.md @@ -1,6 +1,6 @@ # Function: bindFn() -> **bindFn**\<`D`, `A`\>(`originalMethod`, `context`): [`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +> **bindFn**\<`D`, `A`\>(`originalMethod`, `context`): [`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> Defined in: [bind/bind.fn.ts:43](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/bind/bind.fn.ts#L43) @@ -24,7 +24,7 @@ The argument types of the original method ### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to bind @@ -36,7 +36,7 @@ The context (`this`) to bind to ## Returns -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The bound method diff --git a/sdks/typescript/api/decorators/bind/bind.fn/index.md b/sdks/typescript/api/decorators/bind/bind.fn/index.md index 59eb89d9..4141a718 100644 --- a/sdks/typescript/api/decorators/bind/bind.fn/index.md +++ b/sdks/typescript/api/decorators/bind/bind.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [bindFn](./functions/bindFn.md) +- [bindFn](./functions/bindFn) diff --git a/sdks/typescript/api/decorators/bind/bind.types/index.md b/sdks/typescript/api/decorators/bind/bind.types/index.md index 146c3d12..de0cbda2 100644 --- a/sdks/typescript/api/decorators/bind/bind.types/index.md +++ b/sdks/typescript/api/decorators/bind/bind.types/index.md @@ -2,4 +2,4 @@ ## Interfaces -- [BindConfig](./interfaces/BindConfig.md) +- [BindConfig](./interfaces/BindConfig) diff --git a/sdks/typescript/api/decorators/bind/bind/functions/bind.md b/sdks/typescript/api/decorators/bind/bind/functions/bind.md index 8bb7e319..1bffa800 100644 --- a/sdks/typescript/api/decorators/bind/bind/functions/bind.md +++ b/sdks/typescript/api/decorators/bind/bind/functions/bind.md @@ -1,6 +1,6 @@ # Function: bind() -> **bind**\<`T`\>(`_target`, `propertyKey`, `descriptor`): `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`unknown`\>\> +> **bind**\<`T`\>(`_target`, `propertyKey`, `descriptor`): `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`unknown`\>\> Defined in: [bind/bind.ts:88](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/bind/bind.ts#L88) @@ -34,13 +34,13 @@ The name of the method ### descriptor -`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`unknown`\>\> +`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`unknown`\>\> The property descriptor ## Returns -`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`unknown`\>\> +`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`unknown`\>\> The modified descriptor diff --git a/sdks/typescript/api/decorators/bind/bind/index.md b/sdks/typescript/api/decorators/bind/bind/index.md index c1e61e45..7d01a6ee 100644 --- a/sdks/typescript/api/decorators/bind/bind/index.md +++ b/sdks/typescript/api/decorators/bind/bind/index.md @@ -2,4 +2,4 @@ ## Functions -- [bind](./functions/bind.md) +- [bind](./functions/bind) diff --git a/sdks/typescript/api/decorators/bind/index.md b/sdks/typescript/api/decorators/bind/index.md index 1137b3ce..88bb4748 100644 --- a/sdks/typescript/api/decorators/bind/index.md +++ b/sdks/typescript/api/decorators/bind/index.md @@ -4,10 +4,10 @@ ### bind -Re-exports [bind](./bind/functions/bind.md) +Re-exports [bind](./bind/functions/bind) *** ### BindConfig -Re-exports [BindConfig](./bind.types/interfaces/BindConfig.md) +Re-exports [BindConfig](./bind.types/interfaces/BindConfig) diff --git a/sdks/typescript/api/decorators/debounce/debounce.fn/functions/debounceFn.md b/sdks/typescript/api/decorators/debounce/debounce.fn/functions/debounceFn.md index 90dce059..d06870df 100644 --- a/sdks/typescript/api/decorators/debounce/debounce.fn/functions/debounceFn.md +++ b/sdks/typescript/api/decorators/debounce/debounce.fn/functions/debounceFn.md @@ -1,6 +1,6 @@ # Function: debounceFn() -> **debounceFn**\<`D`, `A`\>(`originalMethod`, `delayMs`): [`Method`](../../../types/type-aliases/Method.md)\<`void`, `A`\> +> **debounceFn**\<`D`, `A`\>(`originalMethod`, `delayMs`): [`Method`](../../../types/type-aliases/Method)\<`void`, `A`\> Defined in: [debounce/debounce.fn.ts:52](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/debounce/debounce.fn.ts#L52) @@ -26,7 +26,7 @@ The argument types of the original method ### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to debounce @@ -38,7 +38,7 @@ The debounce delay in milliseconds ## Returns -[`Method`](../../../types/type-aliases/Method.md)\<`void`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`void`, `A`\> The debounced method diff --git a/sdks/typescript/api/decorators/debounce/debounce.fn/index.md b/sdks/typescript/api/decorators/debounce/debounce.fn/index.md index c3507a3d..4bcf01ff 100644 --- a/sdks/typescript/api/decorators/debounce/debounce.fn/index.md +++ b/sdks/typescript/api/decorators/debounce/debounce.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [debounceFn](./functions/debounceFn.md) +- [debounceFn](./functions/debounceFn) diff --git a/sdks/typescript/api/decorators/debounce/debounce/functions/debounce.md b/sdks/typescript/api/decorators/debounce/debounce/functions/debounce.md index 374602c5..63a8cadd 100644 --- a/sdks/typescript/api/decorators/debounce/debounce/functions/debounce.md +++ b/sdks/typescript/api/decorators/debounce/debounce/functions/debounce.md @@ -1,6 +1,6 @@ # Function: debounce() -> **debounce**\<`T`\>(`delayMs`): [`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +> **debounce**\<`T`\>(`delayMs`): [`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> Defined in: [debounce/debounce.ts:47](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/debounce/debounce.ts#L47) @@ -25,7 +25,7 @@ The debounce delay in milliseconds ## Returns -[`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +[`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> The decorator function diff --git a/sdks/typescript/api/decorators/debounce/debounce/index.md b/sdks/typescript/api/decorators/debounce/debounce/index.md index 3d11def2..dc57ad72 100644 --- a/sdks/typescript/api/decorators/debounce/debounce/index.md +++ b/sdks/typescript/api/decorators/debounce/debounce/index.md @@ -2,4 +2,4 @@ ## Functions -- [debounce](./functions/debounce.md) +- [debounce](./functions/debounce) diff --git a/sdks/typescript/api/decorators/debounce/index.md b/sdks/typescript/api/decorators/debounce/index.md index d9639154..ba12bdac 100644 --- a/sdks/typescript/api/decorators/debounce/index.md +++ b/sdks/typescript/api/decorators/debounce/index.md @@ -4,4 +4,4 @@ ### debounceFn -Re-exports [debounceFn](./debounce.fn/functions/debounceFn.md) +Re-exports [debounceFn](./debounce.fn/functions/debounceFn) diff --git a/sdks/typescript/api/decorators/delay/delay.fn/functions/delayFn.md b/sdks/typescript/api/decorators/delay/delay.fn/functions/delayFn.md index 6a54ce53..97047884 100644 --- a/sdks/typescript/api/decorators/delay/delay.fn/functions/delayFn.md +++ b/sdks/typescript/api/decorators/delay/delay.fn/functions/delayFn.md @@ -1,6 +1,6 @@ # Function: delayFn() -> **delayFn**\<`D`, `A`\>(`originalMethod`, `delayMs`): [`Method`](../../../types/type-aliases/Method.md)\<`void`, `A`\> +> **delayFn**\<`D`, `A`\>(`originalMethod`, `delayMs`): [`Method`](../../../types/type-aliases/Method)\<`void`, `A`\> Defined in: [delay/delay.fn.ts:45](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/delay/delay.fn.ts#L45) @@ -24,7 +24,7 @@ The argument types of the original method ### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to delay @@ -36,7 +36,7 @@ The delay time in milliseconds ## Returns -[`Method`](../../../types/type-aliases/Method.md)\<`void`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`void`, `A`\> The delayed method diff --git a/sdks/typescript/api/decorators/delay/delay.fn/index.md b/sdks/typescript/api/decorators/delay/delay.fn/index.md index 515e553e..80b0c030 100644 --- a/sdks/typescript/api/decorators/delay/delay.fn/index.md +++ b/sdks/typescript/api/decorators/delay/delay.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [delayFn](./functions/delayFn.md) +- [delayFn](./functions/delayFn) diff --git a/sdks/typescript/api/decorators/delay/delay/functions/delay.md b/sdks/typescript/api/decorators/delay/delay/functions/delay.md index a236f1b0..101bafea 100644 --- a/sdks/typescript/api/decorators/delay/delay/functions/delay.md +++ b/sdks/typescript/api/decorators/delay/delay/functions/delay.md @@ -1,6 +1,6 @@ # Function: delay() -> **delay**\<`T`\>(`delayMs`): [`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +> **delay**\<`T`\>(`delayMs`): [`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> Defined in: [delay/delay.ts:48](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/delay/delay.ts#L48) @@ -24,7 +24,7 @@ The delay time in milliseconds ## Returns -[`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +[`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> The decorator function diff --git a/sdks/typescript/api/decorators/delay/delay/index.md b/sdks/typescript/api/decorators/delay/delay/index.md index 659dcdd4..d1cc0e13 100644 --- a/sdks/typescript/api/decorators/delay/delay/index.md +++ b/sdks/typescript/api/decorators/delay/delay/index.md @@ -2,4 +2,4 @@ ## Functions -- [delay](./functions/delay.md) +- [delay](./functions/delay) diff --git a/sdks/typescript/api/decorators/delay/index.md b/sdks/typescript/api/decorators/delay/index.md index 7f92c9f6..bf96ad7e 100644 --- a/sdks/typescript/api/decorators/delay/index.md +++ b/sdks/typescript/api/decorators/delay/index.md @@ -4,4 +4,4 @@ ### delay -Re-exports [delay](./delay/functions/delay.md) +Re-exports [delay](./delay/functions/delay) diff --git a/sdks/typescript/api/decorators/delegate/delegate.fn/functions/delegateFn.md b/sdks/typescript/api/decorators/delegate/delegate.fn/functions/delegateFn.md index c8a4621a..d03a25cf 100644 --- a/sdks/typescript/api/decorators/delegate/delegate.fn/functions/delegateFn.md +++ b/sdks/typescript/api/decorators/delegate/delegate.fn/functions/delegateFn.md @@ -1,6 +1,6 @@ # Function: delegateFn() -> **delegateFn**\<`D`, `A`\>(`originalMethod`, `keyResolver?`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +> **delegateFn**\<`D`, `A`\>(`originalMethod`, `keyResolver?`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> Defined in: [delegate/delegate.fn.ts:77](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/delegate/delegate.fn.ts#L77) @@ -26,7 +26,7 @@ The argument types of the original method ### originalMethod -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The async method to wrap @@ -38,7 +38,7 @@ Optional function to generate cache keys ## Returns -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The delegated method diff --git a/sdks/typescript/api/decorators/delegate/delegate.fn/index.md b/sdks/typescript/api/decorators/delegate/delegate.fn/index.md index 1e9d289d..6f5065ca 100644 --- a/sdks/typescript/api/decorators/delegate/delegate.fn/index.md +++ b/sdks/typescript/api/decorators/delegate/delegate.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [delegateFn](./functions/delegateFn.md) +- [delegateFn](./functions/delegateFn) diff --git a/sdks/typescript/api/decorators/delegate/delegate.types/index.md b/sdks/typescript/api/decorators/delegate/delegate.types/index.md index 82981c56..57025897 100644 --- a/sdks/typescript/api/decorators/delegate/delegate.types/index.md +++ b/sdks/typescript/api/decorators/delegate/delegate.types/index.md @@ -2,4 +2,4 @@ ## Type Aliases -- [Delegatable](./type-aliases/Delegatable.md) +- [Delegatable](./type-aliases/Delegatable) diff --git a/sdks/typescript/api/decorators/delegate/delegate.types/type-aliases/Delegatable.md b/sdks/typescript/api/decorators/delegate/delegate.types/type-aliases/Delegatable.md index 4b211066..59e39457 100644 --- a/sdks/typescript/api/decorators/delegate/delegate.types/type-aliases/Delegatable.md +++ b/sdks/typescript/api/decorators/delegate/delegate.types/type-aliases/Delegatable.md @@ -1,6 +1,6 @@ # Type Alias: Delegatable\ -> **Delegatable**\<`T`, `D`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`\>\> +> **Delegatable**\<`T`, `D`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`\>\> Defined in: [delegate/delegate.types.ts:64](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/delegate/delegate.types.ts#L64) @@ -36,13 +36,13 @@ The name of the method being decorated ### descriptor -`TypedPropertyDescriptor`\<[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`\>\> +`TypedPropertyDescriptor`\<[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`\>\> The property descriptor ## Returns -`TypedPropertyDescriptor`\<[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`\>\> +`TypedPropertyDescriptor`\<[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`\>\> The modified descriptor diff --git a/sdks/typescript/api/decorators/delegate/delegate/functions/delegate.md b/sdks/typescript/api/decorators/delegate/delegate/functions/delegate.md index 2ab2932a..b84041b1 100644 --- a/sdks/typescript/api/decorators/delegate/delegate/functions/delegate.md +++ b/sdks/typescript/api/decorators/delegate/delegate/functions/delegate.md @@ -1,6 +1,6 @@ # Function: delegate() -> **delegate**\<`T`, `D`\>(`keyResolver?`): [`Delegatable`](../../delegate.types/type-aliases/Delegatable.md)\<`T`, `D`\> +> **delegate**\<`T`, `D`\>(`keyResolver?`): [`Delegatable`](../../delegate.types/type-aliases/Delegatable)\<`T`, `D`\> Defined in: [delegate/delegate.ts:90](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/delegate/delegate.ts#L90) @@ -32,7 +32,7 @@ Optional function to generate cache keys from arguments ## Returns -[`Delegatable`](../../delegate.types/type-aliases/Delegatable.md)\<`T`, `D`\> +[`Delegatable`](../../delegate.types/type-aliases/Delegatable)\<`T`, `D`\> The decorator function diff --git a/sdks/typescript/api/decorators/delegate/delegate/index.md b/sdks/typescript/api/decorators/delegate/delegate/index.md index eeecbe5a..c8e1f66d 100644 --- a/sdks/typescript/api/decorators/delegate/delegate/index.md +++ b/sdks/typescript/api/decorators/delegate/delegate/index.md @@ -2,4 +2,4 @@ ## Functions -- [delegate](./functions/delegate.md) +- [delegate](./functions/delegate) diff --git a/sdks/typescript/api/decorators/delegate/index.md b/sdks/typescript/api/decorators/delegate/index.md index 15359b36..bd0fac1e 100644 --- a/sdks/typescript/api/decorators/delegate/index.md +++ b/sdks/typescript/api/decorators/delegate/index.md @@ -4,10 +4,10 @@ ### Delegatable -Re-exports [Delegatable](./delegate.types/type-aliases/Delegatable.md) +Re-exports [Delegatable](./delegate.types/type-aliases/Delegatable) *** ### delegate -Re-exports [delegate](./delegate/functions/delegate.md) +Re-exports [delegate](./delegate/functions/delegate) diff --git a/sdks/typescript/api/decorators/exec-time/exec-time.fn/functions/execTimeFn.md b/sdks/typescript/api/decorators/exec-time/exec-time.fn/functions/execTimeFn.md index 78fbfcce..6e94d92c 100644 --- a/sdks/typescript/api/decorators/exec-time/exec-time.fn/functions/execTimeFn.md +++ b/sdks/typescript/api/decorators/exec-time/exec-time.fn/functions/execTimeFn.md @@ -1,6 +1,6 @@ # Function: execTimeFn() -> **execTimeFn**\<`D`, `A`\>(`originalMethod`, `arg?`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`void`, `A`\> +> **execTimeFn**\<`D`, `A`\>(`originalMethod`, `arg?`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`void`, `A`\> Defined in: [exec-time/exec-time.fn.ts:73](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/exec-time/exec-time.fn.ts#L73) @@ -25,19 +25,19 @@ The argument types of the original method ### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> \| [`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> \| [`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The method to wrap ### arg? -`string` \| [`ReportFunction`](../../exec-time.types/type-aliases/ReportFunction.md) +`string` \| [`ReportFunction`](../../exec-time.types/type-aliases/ReportFunction) Optional reporter function or label ## Returns -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`void`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`void`, `A`\> The wrapped method diff --git a/sdks/typescript/api/decorators/exec-time/exec-time.fn/index.md b/sdks/typescript/api/decorators/exec-time/exec-time.fn/index.md index 57ba310c..53aecf4f 100644 --- a/sdks/typescript/api/decorators/exec-time/exec-time.fn/index.md +++ b/sdks/typescript/api/decorators/exec-time/exec-time.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [execTimeFn](./functions/execTimeFn.md) +- [execTimeFn](./functions/execTimeFn) diff --git a/sdks/typescript/api/decorators/exec-time/exec-time.types/index.md b/sdks/typescript/api/decorators/exec-time/exec-time.types/index.md index b2c0ad5b..a0a80845 100644 --- a/sdks/typescript/api/decorators/exec-time/exec-time.types/index.md +++ b/sdks/typescript/api/decorators/exec-time/exec-time.types/index.md @@ -2,9 +2,9 @@ ## Interfaces -- [ExactTimeReportData](./interfaces/ExactTimeReportData.md) +- [ExactTimeReportData](./interfaces/ExactTimeReportData) ## Type Aliases -- [ExactTimeReportable](./type-aliases/ExactTimeReportable.md) -- [ReportFunction](./type-aliases/ReportFunction.md) +- [ExactTimeReportable](./type-aliases/ExactTimeReportable) +- [ReportFunction](./type-aliases/ReportFunction) diff --git a/sdks/typescript/api/decorators/exec-time/exec-time.types/type-aliases/ReportFunction.md b/sdks/typescript/api/decorators/exec-time/exec-time.types/type-aliases/ReportFunction.md index 8edf61ae..39a9640d 100644 --- a/sdks/typescript/api/decorators/exec-time/exec-time.types/type-aliases/ReportFunction.md +++ b/sdks/typescript/api/decorators/exec-time/exec-time.types/type-aliases/ReportFunction.md @@ -10,7 +10,7 @@ Function type for reporting execution time data. ### data -[`ExactTimeReportData`](../interfaces/ExactTimeReportData.md) +[`ExactTimeReportData`](../interfaces/ExactTimeReportData) The execution time report data diff --git a/sdks/typescript/api/decorators/exec-time/exec-time/functions/execTime.md b/sdks/typescript/api/decorators/exec-time/exec-time/functions/execTime.md index d43a1484..8f00dd02 100644 --- a/sdks/typescript/api/decorators/exec-time/exec-time/functions/execTime.md +++ b/sdks/typescript/api/decorators/exec-time/exec-time/functions/execTime.md @@ -17,7 +17,7 @@ Supports both legacy (TypeScript) and standard (Stage 3) decorator formats. ### arg? -`string` \| [`ReportFunction`](../../exec-time.types/type-aliases/ReportFunction.md) +`string` \| [`ReportFunction`](../../exec-time.types/type-aliases/ReportFunction) Optional reporter function or label string diff --git a/sdks/typescript/api/decorators/exec-time/exec-time/index.md b/sdks/typescript/api/decorators/exec-time/exec-time/index.md index 70f2ecf8..c3c12467 100644 --- a/sdks/typescript/api/decorators/exec-time/exec-time/index.md +++ b/sdks/typescript/api/decorators/exec-time/exec-time/index.md @@ -2,4 +2,4 @@ ## Functions -- [execTime](./functions/execTime.md) +- [execTime](./functions/execTime) diff --git a/sdks/typescript/api/decorators/exec-time/index.md b/sdks/typescript/api/decorators/exec-time/index.md index ec9dbbe4..3a853ac8 100644 --- a/sdks/typescript/api/decorators/exec-time/index.md +++ b/sdks/typescript/api/decorators/exec-time/index.md @@ -4,28 +4,28 @@ ### ExactTimeReportable -Re-exports [ExactTimeReportable](./exec-time.types/type-aliases/ExactTimeReportable.md) +Re-exports [ExactTimeReportable](./exec-time.types/type-aliases/ExactTimeReportable) *** ### ExactTimeReportData -Re-exports [ExactTimeReportData](./exec-time.types/interfaces/ExactTimeReportData.md) +Re-exports [ExactTimeReportData](./exec-time.types/interfaces/ExactTimeReportData) *** ### execTime -Re-exports [execTime](./exec-time/functions/execTime.md) +Re-exports [execTime](./exec-time/functions/execTime) *** ### execTimeFn -Re-exports [execTimeFn](./exec-time.fn/functions/execTimeFn.md) +Re-exports [execTimeFn](./exec-time.fn/functions/execTimeFn) *** ### ReportFunction -Re-exports [ReportFunction](./exec-time.types/type-aliases/ReportFunction.md) +Re-exports [ReportFunction](./exec-time.types/type-aliases/ReportFunction) diff --git a/sdks/typescript/api/decorators/execute/execute/index.md b/sdks/typescript/api/decorators/execute/execute/index.md index b391309a..8ab2a6c8 100644 --- a/sdks/typescript/api/decorators/execute/execute/index.md +++ b/sdks/typescript/api/decorators/execute/execute/index.md @@ -2,4 +2,4 @@ ## Functions -- [selfExecute](./functions/selfExecute.md) +- [selfExecute](./functions/selfExecute) diff --git a/sdks/typescript/api/decorators/execute/index.md b/sdks/typescript/api/decorators/execute/index.md index 1bcd8e96..3455a7a7 100644 --- a/sdks/typescript/api/decorators/execute/index.md +++ b/sdks/typescript/api/decorators/execute/index.md @@ -4,4 +4,4 @@ ### selfExecute -Re-exports [selfExecute](./execute/functions/selfExecute.md) +Re-exports [selfExecute](./execute/functions/selfExecute) diff --git a/sdks/typescript/api/decorators/index.md b/sdks/typescript/api/decorators/index.md index 7d7f8d09..d378d249 100644 --- a/sdks/typescript/api/decorators/index.md +++ b/sdks/typescript/api/decorators/index.md @@ -2,60 +2,60 @@ ## Modules -- [\_utils](./utils/index.md) -- [after](./after/index.md) -- [after/after](./after/after/index.md) -- [after/after.fn](./after/after.fn/index.md) -- [after/after.types](./after/after.types/index.md) -- [before](./before/index.md) -- [before/before](./before/before/index.md) -- [before/before.fn](./before/before.fn/index.md) -- [before/before.types](./before/before.types/index.md) -- [bind](./bind/index.md) -- [bind/bind](./bind/bind/index.md) -- [bind/bind.fn](./bind/bind.fn/index.md) -- [bind/bind.types](./bind/bind.types/index.md) -- [debounce](./debounce/index.md) -- [debounce/debounce](./debounce/debounce/index.md) -- [debounce/debounce.fn](./debounce/debounce.fn/index.md) -- [delay](./delay/index.md) -- [delay/delay](./delay/delay/index.md) -- [delay/delay.fn](./delay/delay.fn/index.md) -- [delegate](./delegate/index.md) -- [delegate/delegate](./delegate/delegate/index.md) -- [delegate/delegate.fn](./delegate/delegate.fn/index.md) -- [delegate/delegate.types](./delegate/delegate.types/index.md) -- [exec-time](./exec-time/index.md) -- [exec-time/exec-time](./exec-time/exec-time/index.md) -- [exec-time/exec-time.fn](./exec-time/exec-time.fn/index.md) -- [exec-time/exec-time.types](./exec-time/exec-time.types/index.md) -- [execute](./execute/index.md) -- [execute/execute](./execute/execute/index.md) -- [index](./index/index.md) -- [memoize](./memoize/index.md) -- [memoize-async](./memoize-async/index.md) -- [memoize-async/memoize-async](./memoize-async/memoize-async/index.md) -- [memoize-async/memoize-async.fn](./memoize-async/memoize-async.fn/index.md) -- [memoize-async/memoize-async.types](./memoize-async/memoize-async.types/index.md) -- [memoize/memoize](./memoize/memoize/index.md) -- [memoize/memoize.fn](./memoize/memoize.fn/index.md) -- [memoize/memoize.types](./memoize/memoize.types/index.md) -- [observer](./observer/index.md) -- [observer/observer](./observer/observer/index.md) -- [observer/observer.types](./observer/observer.types/index.md) -- [rate-limit](./rate-limit/index.md) -- [rate-limit/rate-limit](./rate-limit/rate-limit/index.md) -- [rate-limit/rate-limit.fn](./rate-limit/rate-limit.fn/index.md) -- [rate-limit/rate-limit.types](./rate-limit/rate-limit.types/index.md) -- [rate-limit/simple-rate-limit-counter](./rate-limit/simple-rate-limit-counter/index.md) -- [readonly](./readonly/index.md) -- [readonly/readonly](./readonly/readonly/index.md) -- [readonly/readonly.types](./readonly/readonly.types/index.md) -- [throttle](./throttle/index.md) -- [throttle-async](./throttle-async/index.md) -- [throttle-async/throttle-async](./throttle-async/throttle-async/index.md) -- [throttle-async/throttle-async-executor](./throttle-async/throttle-async-executor/index.md) -- [throttle-async/throttle-async.fn](./throttle-async/throttle-async.fn/index.md) -- [throttle/throttle](./throttle/throttle/index.md) -- [throttle/throttle.fn](./throttle/throttle.fn/index.md) -- [types](./types/index.md) +- [\_utils](./utils) +- [after](./after) +- [after/after](./after/after) +- [after/after.fn](./after/after.fn) +- [after/after.types](./after/after.types) +- [before](./before) +- [before/before](./before/before) +- [before/before.fn](./before/before.fn) +- [before/before.types](./before/before.types) +- [bind](./bind) +- [bind/bind](./bind/bind) +- [bind/bind.fn](./bind/bind.fn) +- [bind/bind.types](./bind/bind.types) +- [debounce](./debounce) +- [debounce/debounce](./debounce/debounce) +- [debounce/debounce.fn](./debounce/debounce.fn) +- [delay](./delay) +- [delay/delay](./delay/delay) +- [delay/delay.fn](./delay/delay.fn) +- [delegate](./delegate) +- [delegate/delegate](./delegate/delegate) +- [delegate/delegate.fn](./delegate/delegate.fn) +- [delegate/delegate.types](./delegate/delegate.types) +- [exec-time](./exec-time) +- [exec-time/exec-time](./exec-time/exec-time) +- [exec-time/exec-time.fn](./exec-time/exec-time.fn) +- [exec-time/exec-time.types](./exec-time/exec-time.types) +- [execute](./execute) +- [execute/execute](./execute/execute) +- [index](./index) +- [memoize](./memoize) +- [memoize-async](./memoize-async) +- [memoize-async/memoize-async](./memoize-async/memoize-async) +- [memoize-async/memoize-async.fn](./memoize-async/memoize-async.fn) +- [memoize-async/memoize-async.types](./memoize-async/memoize-async.types) +- [memoize/memoize](./memoize/memoize) +- [memoize/memoize.fn](./memoize/memoize.fn) +- [memoize/memoize.types](./memoize/memoize.types) +- [observer](./observer) +- [observer/observer](./observer/observer) +- [observer/observer.types](./observer/observer.types) +- [rate-limit](./rate-limit) +- [rate-limit/rate-limit](./rate-limit/rate-limit) +- [rate-limit/rate-limit.fn](./rate-limit/rate-limit.fn) +- [rate-limit/rate-limit.types](./rate-limit/rate-limit.types) +- [rate-limit/simple-rate-limit-counter](./rate-limit/simple-rate-limit-counter) +- [readonly](./readonly) +- [readonly/readonly](./readonly/readonly) +- [readonly/readonly.types](./readonly/readonly.types) +- [throttle](./throttle) +- [throttle-async](./throttle-async) +- [throttle-async/throttle-async](./throttle-async/throttle-async) +- [throttle-async/throttle-async-executor](./throttle-async/throttle-async-executor) +- [throttle-async/throttle-async.fn](./throttle-async/throttle-async.fn) +- [throttle/throttle](./throttle/throttle) +- [throttle/throttle.fn](./throttle/throttle.fn) +- [types](./types) diff --git a/sdks/typescript/api/decorators/index/index.md b/sdks/typescript/api/decorators/index/index.md index cab7486e..b3282fcb 100644 --- a/sdks/typescript/api/decorators/index/index.md +++ b/sdks/typescript/api/decorators/index/index.md @@ -4,262 +4,262 @@ ### after -Re-exports [after](../after/after/functions/after.md) +Re-exports [after](../after/after/functions/after) *** ### AfterConfig -Re-exports [AfterConfig](../after/after.types/interfaces/AfterConfig.md) +Re-exports [AfterConfig](../after/after.types/interfaces/AfterConfig) *** ### AfterFunc -Re-exports [AfterFunc](../after/after.types/type-aliases/AfterFunc.md) +Re-exports [AfterFunc](../after/after.types/type-aliases/AfterFunc) *** ### AfterParams -Re-exports [AfterParams](../after/after.types/interfaces/AfterParams.md) +Re-exports [AfterParams](../after/after.types/interfaces/AfterParams) *** ### AsyncCache -Re-exports [AsyncCache](../memoize-async/memoize-async.types/interfaces/AsyncCache.md) +Re-exports [AsyncCache](../memoize-async/memoize-async.types/interfaces/AsyncCache) *** ### AsyncDecorator -Re-exports [AsyncDecorator](../types/type-aliases/AsyncDecorator.md) +Re-exports [AsyncDecorator](../types/type-aliases/AsyncDecorator) *** ### AsyncMemoizable -Re-exports [AsyncMemoizable](../memoize-async/memoize-async.types/type-aliases/AsyncMemoizable.md) +Re-exports [AsyncMemoizable](../memoize-async/memoize-async.types/type-aliases/AsyncMemoizable) *** ### AsyncMemoizeConfig -Re-exports [AsyncMemoizeConfig](../memoize-async/memoize-async.types/interfaces/AsyncMemoizeConfig.md) +Re-exports [AsyncMemoizeConfig](../memoize-async/memoize-async.types/interfaces/AsyncMemoizeConfig) *** ### AsyncMethod -Re-exports [AsyncMethod](../types/type-aliases/AsyncMethod.md) +Re-exports [AsyncMethod](../types/type-aliases/AsyncMethod) *** ### before -Re-exports [before](../before/before/functions/before.md) +Re-exports [before](../before/before/functions/before) *** ### BeforeConfig -Re-exports [BeforeConfig](../before/before.types/interfaces/BeforeConfig.md) +Re-exports [BeforeConfig](../before/before.types/interfaces/BeforeConfig) *** ### bind -Re-exports [bind](../bind/bind/functions/bind.md) +Re-exports [bind](../bind/bind/functions/bind) *** ### BindConfig -Re-exports [BindConfig](../bind/bind.types/interfaces/BindConfig.md) +Re-exports [BindConfig](../bind/bind.types/interfaces/BindConfig) *** ### Cache -Re-exports [Cache](../memoize/memoize.types/interfaces/Cache.md) +Re-exports [Cache](../memoize/memoize.types/interfaces/Cache) *** ### debounceFn -Re-exports [debounceFn](../debounce/debounce.fn/functions/debounceFn.md) +Re-exports [debounceFn](../debounce/debounce.fn/functions/debounceFn) *** ### Decorator -Re-exports [Decorator](../types/type-aliases/Decorator.md) +Re-exports [Decorator](../types/type-aliases/Decorator) *** ### delay -Re-exports [delay](../delay/delay/functions/delay.md) +Re-exports [delay](../delay/delay/functions/delay) *** ### Delegatable -Re-exports [Delegatable](../delegate/delegate.types/type-aliases/Delegatable.md) +Re-exports [Delegatable](../delegate/delegate.types/type-aliases/Delegatable) *** ### delegate -Re-exports [delegate](../delegate/delegate/functions/delegate.md) +Re-exports [delegate](../delegate/delegate/functions/delegate) *** ### ExactTimeReportable -Re-exports [ExactTimeReportable](../exec-time/exec-time.types/type-aliases/ExactTimeReportable.md) +Re-exports [ExactTimeReportable](../exec-time/exec-time.types/type-aliases/ExactTimeReportable) *** ### ExactTimeReportData -Re-exports [ExactTimeReportData](../exec-time/exec-time.types/interfaces/ExactTimeReportData.md) +Re-exports [ExactTimeReportData](../exec-time/exec-time.types/interfaces/ExactTimeReportData) *** ### execTime -Re-exports [execTime](../exec-time/exec-time/functions/execTime.md) +Re-exports [execTime](../exec-time/exec-time/functions/execTime) *** ### execTimeFn -Re-exports [execTimeFn](../exec-time/exec-time.fn/functions/execTimeFn.md) +Re-exports [execTimeFn](../exec-time/exec-time.fn/functions/execTimeFn) *** ### KeyResolver -Re-exports [KeyResolver](../memoize/memoize.types/type-aliases/KeyResolver.md) +Re-exports [KeyResolver](../memoize/memoize.types/type-aliases/KeyResolver) *** ### Memoizable -Re-exports [Memoizable](../memoize/memoize.types/type-aliases/Memoizable.md) +Re-exports [Memoizable](../memoize/memoize.types/type-aliases/Memoizable) *** ### memoize -Re-exports [memoize](../memoize/memoize/functions/memoize.md) +Re-exports [memoize](../memoize/memoize/functions/memoize) *** ### memoizeAsync -Re-exports [memoizeAsync](../memoize-async/memoize-async/functions/memoizeAsync.md) +Re-exports [memoizeAsync](../memoize-async/memoize-async/functions/memoizeAsync) *** ### memoizeAsyncFn -Re-exports [memoizeAsyncFn](../memoize-async/memoize-async.fn/functions/memoizeAsyncFn.md) +Re-exports [memoizeAsyncFn](../memoize-async/memoize-async.fn/functions/memoizeAsyncFn) *** ### MemoizeConfig -Re-exports [MemoizeConfig](../memoize/memoize.types/interfaces/MemoizeConfig.md) +Re-exports [MemoizeConfig](../memoize/memoize.types/interfaces/MemoizeConfig) *** ### Method -Re-exports [Method](../types/type-aliases/Method.md) +Re-exports [Method](../types/type-aliases/Method) *** ### observe -Re-exports [observe](../observer/observer/functions/observe.md) +Re-exports [observe](../observer/observer/functions/observe) *** ### ObserverCallback -Re-exports [ObserverCallback](../observer/observer.types/type-aliases/ObserverCallback.md) +Re-exports [ObserverCallback](../observer/observer.types/type-aliases/ObserverCallback) *** ### rateLimit -Re-exports [rateLimit](../rate-limit/rate-limit/functions/rateLimit.md) +Re-exports [rateLimit](../rate-limit/rate-limit/functions/rateLimit) *** ### RateLimitable -Re-exports [RateLimitable](../rate-limit/rate-limit.types/type-aliases/RateLimitable.md) +Re-exports [RateLimitable](../rate-limit/rate-limit.types/type-aliases/RateLimitable) *** ### RateLimitAsyncCounter -Re-exports [RateLimitAsyncCounter](../rate-limit/rate-limit.types/interfaces/RateLimitAsyncCounter.md) +Re-exports [RateLimitAsyncCounter](../rate-limit/rate-limit.types/interfaces/RateLimitAsyncCounter) *** ### RateLimitConfigs -Re-exports [RateLimitConfigs](../rate-limit/rate-limit.types/interfaces/RateLimitConfigs.md) +Re-exports [RateLimitConfigs](../rate-limit/rate-limit.types/interfaces/RateLimitConfigs) *** ### RateLimitCounter -Re-exports [RateLimitCounter](../rate-limit/rate-limit.types/interfaces/RateLimitCounter.md) +Re-exports [RateLimitCounter](../rate-limit/rate-limit.types/interfaces/RateLimitCounter) *** ### readonly -Re-exports [readonly](../readonly/readonly/functions/readonly.md) +Re-exports [readonly](../readonly/readonly/functions/readonly) *** ### Readonlyable -Re-exports [Readonlyable](../readonly/readonly.types/type-aliases/Readonlyable.md) +Re-exports [Readonlyable](../readonly/readonly.types/type-aliases/Readonlyable) *** ### ReportFunction -Re-exports [ReportFunction](../exec-time/exec-time.types/type-aliases/ReportFunction.md) +Re-exports [ReportFunction](../exec-time/exec-time.types/type-aliases/ReportFunction) *** ### selfExecute -Re-exports [selfExecute](../execute/execute/functions/selfExecute.md) +Re-exports [selfExecute](../execute/execute/functions/selfExecute) *** ### SimpleRateLimitCounter -Re-exports [SimpleRateLimitCounter](../rate-limit/simple-rate-limit-counter/classes/SimpleRateLimitCounter.md) +Re-exports [SimpleRateLimitCounter](../rate-limit/simple-rate-limit-counter/classes/SimpleRateLimitCounter) *** ### throttle -Re-exports [throttle](../throttle/throttle/functions/throttle.md) +Re-exports [throttle](../throttle/throttle/functions/throttle) *** ### throttleAsync -Re-exports [throttleAsync](../throttle-async/throttle-async/functions/throttleAsync.md) +Re-exports [throttleAsync](../throttle-async/throttle-async/functions/throttleAsync) diff --git a/sdks/typescript/api/decorators/memoize-async/index.md b/sdks/typescript/api/decorators/memoize-async/index.md index 7d7d2e44..813982f2 100644 --- a/sdks/typescript/api/decorators/memoize-async/index.md +++ b/sdks/typescript/api/decorators/memoize-async/index.md @@ -4,28 +4,28 @@ ### AsyncCache -Re-exports [AsyncCache](./memoize-async.types/interfaces/AsyncCache.md) +Re-exports [AsyncCache](./memoize-async.types/interfaces/AsyncCache) *** ### AsyncMemoizable -Re-exports [AsyncMemoizable](./memoize-async.types/type-aliases/AsyncMemoizable.md) +Re-exports [AsyncMemoizable](./memoize-async.types/type-aliases/AsyncMemoizable) *** ### AsyncMemoizeConfig -Re-exports [AsyncMemoizeConfig](./memoize-async.types/interfaces/AsyncMemoizeConfig.md) +Re-exports [AsyncMemoizeConfig](./memoize-async.types/interfaces/AsyncMemoizeConfig) *** ### memoizeAsync -Re-exports [memoizeAsync](./memoize-async/functions/memoizeAsync.md) +Re-exports [memoizeAsync](./memoize-async/functions/memoizeAsync) *** ### memoizeAsyncFn -Re-exports [memoizeAsyncFn](./memoize-async.fn/functions/memoizeAsyncFn.md) +Re-exports [memoizeAsyncFn](./memoize-async.fn/functions/memoizeAsyncFn) diff --git a/sdks/typescript/api/decorators/memoize-async/memoize-async.fn/functions/memoizeAsyncFn.md b/sdks/typescript/api/decorators/memoize-async/memoize-async.fn/functions/memoizeAsyncFn.md index 0b496d35..aad239f8 100644 --- a/sdks/typescript/api/decorators/memoize-async/memoize-async.fn/functions/memoizeAsyncFn.md +++ b/sdks/typescript/api/decorators/memoize-async/memoize-async.fn/functions/memoizeAsyncFn.md @@ -2,7 +2,7 @@ ## Call Signature -> **memoizeAsyncFn**\<`D`, `A`\>(`originalMethod`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +> **memoizeAsyncFn**\<`D`, `A`\>(`originalMethod`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> Defined in: [memoize-async/memoize-async.fn.ts:80](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.fn.ts#L80) @@ -26,13 +26,13 @@ The argument types of the original method #### originalMethod -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The async method to memoize ### Returns -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The memoized method @@ -75,7 +75,7 @@ const withConfig = memoizeAsyncFn( ## Call Signature -> **memoizeAsyncFn**\<`D`, `A`\>(`originalMethod`, `config`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +> **memoizeAsyncFn**\<`D`, `A`\>(`originalMethod`, `config`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> Defined in: [memoize-async/memoize-async.fn.ts:83](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.fn.ts#L83) @@ -99,19 +99,19 @@ The argument types of the original method #### originalMethod -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The async method to memoize #### config -[`AsyncMemoizeConfig`](../../memoize-async.types/interfaces/AsyncMemoizeConfig.md)\<`any`, `D`\> +[`AsyncMemoizeConfig`](../../memoize-async.types/interfaces/AsyncMemoizeConfig)\<`any`, `D`\> Configuration for memoization ### Returns -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The memoized method @@ -154,7 +154,7 @@ const withConfig = memoizeAsyncFn( ## Call Signature -> **memoizeAsyncFn**\<`D`, `A`\>(`originalMethod`, `expirationTimeMs`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +> **memoizeAsyncFn**\<`D`, `A`\>(`originalMethod`, `expirationTimeMs`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> Defined in: [memoize-async/memoize-async.fn.ts:87](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.fn.ts#L87) @@ -178,7 +178,7 @@ The argument types of the original method #### originalMethod -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The async method to memoize @@ -190,7 +190,7 @@ Cache expiration time in milliseconds ### Returns -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The memoized method diff --git a/sdks/typescript/api/decorators/memoize-async/memoize-async.fn/index.md b/sdks/typescript/api/decorators/memoize-async/memoize-async.fn/index.md index da0bd4c0..68f1c174 100644 --- a/sdks/typescript/api/decorators/memoize-async/memoize-async.fn/index.md +++ b/sdks/typescript/api/decorators/memoize-async/memoize-async.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [memoizeAsyncFn](./functions/memoizeAsyncFn.md) +- [memoizeAsyncFn](./functions/memoizeAsyncFn) diff --git a/sdks/typescript/api/decorators/memoize-async/memoize-async.types/index.md b/sdks/typescript/api/decorators/memoize-async/memoize-async.types/index.md index 513830a5..4fef87ff 100644 --- a/sdks/typescript/api/decorators/memoize-async/memoize-async.types/index.md +++ b/sdks/typescript/api/decorators/memoize-async/memoize-async.types/index.md @@ -2,9 +2,9 @@ ## Interfaces -- [AsyncCache](./interfaces/AsyncCache.md) -- [AsyncMemoizeConfig](./interfaces/AsyncMemoizeConfig.md) +- [AsyncCache](./interfaces/AsyncCache) +- [AsyncMemoizeConfig](./interfaces/AsyncMemoizeConfig) ## Type Aliases -- [AsyncMemoizable](./type-aliases/AsyncMemoizable.md) +- [AsyncMemoizable](./type-aliases/AsyncMemoizable) diff --git a/sdks/typescript/api/decorators/memoize-async/memoize-async.types/interfaces/AsyncMemoizeConfig.md b/sdks/typescript/api/decorators/memoize-async/memoize-async.types/interfaces/AsyncMemoizeConfig.md index d0fd0453..bfb10a8f 100644 --- a/sdks/typescript/api/decorators/memoize-async/memoize-async.types/interfaces/AsyncMemoizeConfig.md +++ b/sdks/typescript/api/decorators/memoize-async/memoize-async.types/interfaces/AsyncMemoizeConfig.md @@ -38,7 +38,7 @@ The resolved type of the async method ### cache? -> `optional` **cache?**: [`Cache`](../../../memoize/memoize.types/interfaces/Cache.md)\<`D`\> \| [`AsyncCache`](./AsyncCache.md)\<`D`\> +> `optional` **cache?**: [`Cache`](../../../memoize/memoize.types/interfaces/Cache)\<`D`\> \| [`AsyncCache`](./AsyncCache)\<`D`\> Defined in: [memoize-async/memoize-async.types.ts:83](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.types.ts#L83) @@ -58,7 +58,7 @@ Time in milliseconds after which cached values expire ### keyResolver? -> `optional` **keyResolver?**: [`KeyResolver`](../../../memoize/memoize.types/type-aliases/KeyResolver.md) \| keyof `T` +> `optional` **keyResolver?**: [`KeyResolver`](../../../memoize/memoize.types/type-aliases/KeyResolver) \| keyof `T` Defined in: [memoize-async/memoize-async.types.ts:85](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.types.ts#L85) diff --git a/sdks/typescript/api/decorators/memoize-async/memoize-async.types/type-aliases/AsyncMemoizable.md b/sdks/typescript/api/decorators/memoize-async/memoize-async.types/type-aliases/AsyncMemoizable.md index 1140e77e..f13f997e 100644 --- a/sdks/typescript/api/decorators/memoize-async/memoize-async.types/type-aliases/AsyncMemoizable.md +++ b/sdks/typescript/api/decorators/memoize-async/memoize-async.types/type-aliases/AsyncMemoizable.md @@ -1,6 +1,6 @@ # Type Alias: AsyncMemoizable\ -> **AsyncMemoizable**\<`T`, `D`\> = [`Memoizable`](../../../memoize/memoize.types/type-aliases/Memoizable.md)\<`T`, `Promise`\<`D`\>\> +> **AsyncMemoizable**\<`T`, `D`\> = [`Memoizable`](../../../memoize/memoize.types/type-aliases/Memoizable)\<`T`, `Promise`\<`D`\>\> Defined in: [memoize-async/memoize-async.types.ts:26](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.types.ts#L26) diff --git a/sdks/typescript/api/decorators/memoize-async/memoize-async/functions/memoizeAsync.md b/sdks/typescript/api/decorators/memoize-async/memoize-async/functions/memoizeAsync.md index fa1f84a2..fc5b2cf2 100644 --- a/sdks/typescript/api/decorators/memoize-async/memoize-async/functions/memoizeAsync.md +++ b/sdks/typescript/api/decorators/memoize-async/memoize-async/functions/memoizeAsync.md @@ -2,7 +2,7 @@ ## Call Signature -> **memoizeAsync**\<`T`, `D`\>(): [`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable.md)\<`T`, `D`\> +> **memoizeAsync**\<`T`, `D`\>(): [`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable)\<`T`, `D`\> Defined in: [memoize-async/memoize-async.ts:105](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.ts#L105) @@ -26,7 +26,7 @@ The resolved type of the async method ### Returns -[`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable.md)\<`T`, `D`\> +[`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable)\<`T`, `D`\> The decorator function @@ -72,7 +72,7 @@ const [product1, product2] = await Promise.all([ ## Call Signature -> **memoizeAsync**\<`T`, `D`\>(`config`): [`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable.md)\<`T`, `D`\> +> **memoizeAsync**\<`T`, `D`\>(`config`): [`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable)\<`T`, `D`\> Defined in: [memoize-async/memoize-async.ts:106](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.ts#L106) @@ -98,13 +98,13 @@ The resolved type of the async method #### config -[`AsyncMemoizeConfig`](../../memoize-async.types/interfaces/AsyncMemoizeConfig.md)\<`T`, `D`\> +[`AsyncMemoizeConfig`](../../memoize-async.types/interfaces/AsyncMemoizeConfig)\<`T`, `D`\> Configuration for memoization ### Returns -[`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable.md)\<`T`, `D`\> +[`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable)\<`T`, `D`\> The decorator function @@ -150,7 +150,7 @@ const [product1, product2] = await Promise.all([ ## Call Signature -> **memoizeAsync**\<`T`, `D`\>(`expirationTimeMs`): [`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable.md)\<`T`, `D`\> +> **memoizeAsync**\<`T`, `D`\>(`expirationTimeMs`): [`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable)\<`T`, `D`\> Defined in: [memoize-async/memoize-async.ts:109](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize-async/memoize-async.ts#L109) @@ -182,7 +182,7 @@ Cache expiration time in milliseconds ### Returns -[`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable.md)\<`T`, `D`\> +[`AsyncMemoizable`](../../memoize-async.types/type-aliases/AsyncMemoizable)\<`T`, `D`\> The decorator function diff --git a/sdks/typescript/api/decorators/memoize-async/memoize-async/index.md b/sdks/typescript/api/decorators/memoize-async/memoize-async/index.md index 119dfcf8..168f2bc6 100644 --- a/sdks/typescript/api/decorators/memoize-async/memoize-async/index.md +++ b/sdks/typescript/api/decorators/memoize-async/memoize-async/index.md @@ -2,4 +2,4 @@ ## Functions -- [memoizeAsync](./functions/memoizeAsync.md) +- [memoizeAsync](./functions/memoizeAsync) diff --git a/sdks/typescript/api/decorators/memoize/index.md b/sdks/typescript/api/decorators/memoize/index.md index 3ad674f3..64770193 100644 --- a/sdks/typescript/api/decorators/memoize/index.md +++ b/sdks/typescript/api/decorators/memoize/index.md @@ -4,28 +4,28 @@ ### Cache -Re-exports [Cache](./memoize.types/interfaces/Cache.md) +Re-exports [Cache](./memoize.types/interfaces/Cache) *** ### KeyResolver -Re-exports [KeyResolver](./memoize.types/type-aliases/KeyResolver.md) +Re-exports [KeyResolver](./memoize.types/type-aliases/KeyResolver) *** ### Memoizable -Re-exports [Memoizable](./memoize.types/type-aliases/Memoizable.md) +Re-exports [Memoizable](./memoize.types/type-aliases/Memoizable) *** ### memoize -Re-exports [memoize](./memoize/functions/memoize.md) +Re-exports [memoize](./memoize/functions/memoize) *** ### MemoizeConfig -Re-exports [MemoizeConfig](./memoize.types/interfaces/MemoizeConfig.md) +Re-exports [MemoizeConfig](./memoize.types/interfaces/MemoizeConfig) diff --git a/sdks/typescript/api/decorators/memoize/memoize.fn/functions/memoizeFn.md b/sdks/typescript/api/decorators/memoize/memoize.fn/functions/memoizeFn.md index ccb24c7a..03715cd7 100644 --- a/sdks/typescript/api/decorators/memoize/memoize.fn/functions/memoizeFn.md +++ b/sdks/typescript/api/decorators/memoize/memoize.fn/functions/memoizeFn.md @@ -2,7 +2,7 @@ ## Call Signature -> **memoizeFn**\<`D`, `A`\>(`originalMethod`): [`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +> **memoizeFn**\<`D`, `A`\>(`originalMethod`): [`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> Defined in: [memoize/memoize.fn.ts:80](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.fn.ts#L80) @@ -26,13 +26,13 @@ The argument types of the original method #### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to memoize ### Returns -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The memoized method @@ -75,7 +75,7 @@ const withConfig = memoizeFn( ## Call Signature -> **memoizeFn**\<`D`, `A`\>(`originalMethod`, `config`): [`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +> **memoizeFn**\<`D`, `A`\>(`originalMethod`, `config`): [`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> Defined in: [memoize/memoize.fn.ts:83](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.fn.ts#L83) @@ -99,19 +99,19 @@ The argument types of the original method #### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to memoize #### config -[`MemoizeConfig`](../../memoize.types/interfaces/MemoizeConfig.md)\<`any`, `D`\> +[`MemoizeConfig`](../../memoize.types/interfaces/MemoizeConfig)\<`any`, `D`\> Configuration for memoization ### Returns -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The memoized method @@ -154,7 +154,7 @@ const withConfig = memoizeFn( ## Call Signature -> **memoizeFn**\<`D`, `A`\>(`originalMethod`, `expirationTimeMs`): [`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +> **memoizeFn**\<`D`, `A`\>(`originalMethod`, `expirationTimeMs`): [`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> Defined in: [memoize/memoize.fn.ts:87](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.fn.ts#L87) @@ -178,7 +178,7 @@ The argument types of the original method #### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to memoize @@ -190,7 +190,7 @@ Cache expiration time in milliseconds ### Returns -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The memoized method diff --git a/sdks/typescript/api/decorators/memoize/memoize.fn/index.md b/sdks/typescript/api/decorators/memoize/memoize.fn/index.md index 851cbee0..89259acc 100644 --- a/sdks/typescript/api/decorators/memoize/memoize.fn/index.md +++ b/sdks/typescript/api/decorators/memoize/memoize.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [memoizeFn](./functions/memoizeFn.md) +- [memoizeFn](./functions/memoizeFn) diff --git a/sdks/typescript/api/decorators/memoize/memoize.types/index.md b/sdks/typescript/api/decorators/memoize/memoize.types/index.md index 1cfd2320..8e94900b 100644 --- a/sdks/typescript/api/decorators/memoize/memoize.types/index.md +++ b/sdks/typescript/api/decorators/memoize/memoize.types/index.md @@ -2,10 +2,10 @@ ## Interfaces -- [Cache](./interfaces/Cache.md) -- [MemoizeConfig](./interfaces/MemoizeConfig.md) +- [Cache](./interfaces/Cache) +- [MemoizeConfig](./interfaces/MemoizeConfig) ## Type Aliases -- [KeyResolver](./type-aliases/KeyResolver.md) -- [Memoizable](./type-aliases/Memoizable.md) +- [KeyResolver](./type-aliases/KeyResolver) +- [Memoizable](./type-aliases/Memoizable) diff --git a/sdks/typescript/api/decorators/memoize/memoize.types/interfaces/MemoizeConfig.md b/sdks/typescript/api/decorators/memoize/memoize.types/interfaces/MemoizeConfig.md index a81b0932..e5ad2435 100644 --- a/sdks/typescript/api/decorators/memoize/memoize.types/interfaces/MemoizeConfig.md +++ b/sdks/typescript/api/decorators/memoize/memoize.types/interfaces/MemoizeConfig.md @@ -38,7 +38,7 @@ The return type of the decorated method ### cache? -> `optional` **cache?**: [`Cache`](./Cache.md)\<`D`\> +> `optional` **cache?**: [`Cache`](./Cache)\<`D`\> Defined in: [memoize/memoize.types.ts:111](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.types.ts#L111) @@ -58,7 +58,7 @@ Time in milliseconds after which cached values expire ### keyResolver? -> `optional` **keyResolver?**: [`KeyResolver`](../type-aliases/KeyResolver.md) \| keyof `T` +> `optional` **keyResolver?**: [`KeyResolver`](../type-aliases/KeyResolver) \| keyof `T` Defined in: [memoize/memoize.types.ts:113](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.types.ts#L113) diff --git a/sdks/typescript/api/decorators/memoize/memoize.types/type-aliases/Memoizable.md b/sdks/typescript/api/decorators/memoize/memoize.types/type-aliases/Memoizable.md index 2b45364d..af668ade 100644 --- a/sdks/typescript/api/decorators/memoize/memoize.types/type-aliases/Memoizable.md +++ b/sdks/typescript/api/decorators/memoize/memoize.types/type-aliases/Memoizable.md @@ -1,6 +1,6 @@ # Type Alias: Memoizable\ -> **Memoizable**\<`T`, `D`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`D`\>\> +> **Memoizable**\<`T`, `D`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`D`\>\> Defined in: [memoize/memoize.types.ts:129](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.types.ts#L129) @@ -36,13 +36,13 @@ The name of the method being decorated ### descriptor -`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`D`\>\> +`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`D`\>\> The property descriptor ## Returns -`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`D`\>\> +`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`D`\>\> The modified descriptor diff --git a/sdks/typescript/api/decorators/memoize/memoize/functions/memoize.md b/sdks/typescript/api/decorators/memoize/memoize/functions/memoize.md index ffe77014..56bbca6e 100644 --- a/sdks/typescript/api/decorators/memoize/memoize/functions/memoize.md +++ b/sdks/typescript/api/decorators/memoize/memoize/functions/memoize.md @@ -2,7 +2,7 @@ ## Call Signature -> **memoize**\<`T`, `D`\>(): [`Memoizable`](../../memoize.types/type-aliases/Memoizable.md)\<`T`, `D`\> +> **memoize**\<`T`, `D`\>(): [`Memoizable`](../../memoize.types/type-aliases/Memoizable)\<`T`, `D`\> Defined in: [memoize/memoize.ts:121](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.ts#L121) @@ -25,7 +25,7 @@ The return type of the decorated method ### Returns -[`Memoizable`](../../memoize.types/type-aliases/Memoizable.md)\<`T`, `D`\> +[`Memoizable`](../../memoize.types/type-aliases/Memoizable)\<`T`, `D`\> The decorator function @@ -71,7 +71,7 @@ const user2 = service.getUser('123'); // Instant, no database query ## Call Signature -> **memoize**\<`T`, `D`\>(`config`): [`Memoizable`](../../memoize.types/type-aliases/Memoizable.md)\<`T`, `D`\> +> **memoize**\<`T`, `D`\>(`config`): [`Memoizable`](../../memoize.types/type-aliases/Memoizable)\<`T`, `D`\> Defined in: [memoize/memoize.ts:122](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.ts#L122) @@ -96,13 +96,13 @@ The return type of the decorated method #### config -[`MemoizeConfig`](../../memoize.types/interfaces/MemoizeConfig.md)\<`T`, `D`\> +[`MemoizeConfig`](../../memoize.types/interfaces/MemoizeConfig)\<`T`, `D`\> Configuration for memoization ### Returns -[`Memoizable`](../../memoize.types/type-aliases/Memoizable.md)\<`T`, `D`\> +[`Memoizable`](../../memoize.types/type-aliases/Memoizable)\<`T`, `D`\> The decorator function @@ -148,7 +148,7 @@ const user2 = service.getUser('123'); // Instant, no database query ## Call Signature -> **memoize**\<`T`, `D`\>(`expirationTimeMs`): [`Memoizable`](../../memoize.types/type-aliases/Memoizable.md)\<`T`, `D`\> +> **memoize**\<`T`, `D`\>(`expirationTimeMs`): [`Memoizable`](../../memoize.types/type-aliases/Memoizable)\<`T`, `D`\> Defined in: [memoize/memoize.ts:123](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/memoize/memoize.ts#L123) @@ -179,7 +179,7 @@ Cache expiration time in milliseconds ### Returns -[`Memoizable`](../../memoize.types/type-aliases/Memoizable.md)\<`T`, `D`\> +[`Memoizable`](../../memoize.types/type-aliases/Memoizable)\<`T`, `D`\> The decorator function diff --git a/sdks/typescript/api/decorators/memoize/memoize/index.md b/sdks/typescript/api/decorators/memoize/memoize/index.md index d07d1d2f..31462fee 100644 --- a/sdks/typescript/api/decorators/memoize/memoize/index.md +++ b/sdks/typescript/api/decorators/memoize/memoize/index.md @@ -2,4 +2,4 @@ ## Functions -- [memoize](./functions/memoize.md) +- [memoize](./functions/memoize) diff --git a/sdks/typescript/api/decorators/observer/index.md b/sdks/typescript/api/decorators/observer/index.md index c8e05548..3c492580 100644 --- a/sdks/typescript/api/decorators/observer/index.md +++ b/sdks/typescript/api/decorators/observer/index.md @@ -4,10 +4,10 @@ ### observe -Re-exports [observe](./observer/functions/observe.md) +Re-exports [observe](./observer/functions/observe) *** ### ObserverCallback -Re-exports [ObserverCallback](./observer.types/type-aliases/ObserverCallback.md) +Re-exports [ObserverCallback](./observer.types/type-aliases/ObserverCallback) diff --git a/sdks/typescript/api/decorators/observer/observer.types/index.md b/sdks/typescript/api/decorators/observer/observer.types/index.md index 5bc2c4fc..b9ba274a 100644 --- a/sdks/typescript/api/decorators/observer/observer.types/index.md +++ b/sdks/typescript/api/decorators/observer/observer.types/index.md @@ -2,4 +2,4 @@ ## Type Aliases -- [ObserverCallback](./type-aliases/ObserverCallback.md) +- [ObserverCallback](./type-aliases/ObserverCallback) diff --git a/sdks/typescript/api/decorators/observer/observer/functions/observe.md b/sdks/typescript/api/decorators/observer/observer/functions/observe.md index 96a2a472..a300aa6f 100644 --- a/sdks/typescript/api/decorators/observer/observer/functions/observe.md +++ b/sdks/typescript/api/decorators/observer/observer/functions/observe.md @@ -74,7 +74,7 @@ The type of the property value #### cb -[`ObserverCallback`](../../observer.types/type-aliases/ObserverCallback.md)\<`T`\> +[`ObserverCallback`](../../observer.types/type-aliases/ObserverCallback)\<`T`\> Callback to execute on assignment of observed variable diff --git a/sdks/typescript/api/decorators/observer/observer/index.md b/sdks/typescript/api/decorators/observer/observer/index.md index 5e102518..9290f9dd 100644 --- a/sdks/typescript/api/decorators/observer/observer/index.md +++ b/sdks/typescript/api/decorators/observer/observer/index.md @@ -2,4 +2,4 @@ ## Functions -- [observe](./functions/observe.md) +- [observe](./functions/observe) diff --git a/sdks/typescript/api/decorators/rate-limit/index.md b/sdks/typescript/api/decorators/rate-limit/index.md index 496b0354..d160203f 100644 --- a/sdks/typescript/api/decorators/rate-limit/index.md +++ b/sdks/typescript/api/decorators/rate-limit/index.md @@ -4,34 +4,34 @@ ### rateLimit -Re-exports [rateLimit](./rate-limit/functions/rateLimit.md) +Re-exports [rateLimit](./rate-limit/functions/rateLimit) *** ### RateLimitable -Re-exports [RateLimitable](./rate-limit.types/type-aliases/RateLimitable.md) +Re-exports [RateLimitable](./rate-limit.types/type-aliases/RateLimitable) *** ### RateLimitAsyncCounter -Re-exports [RateLimitAsyncCounter](./rate-limit.types/interfaces/RateLimitAsyncCounter.md) +Re-exports [RateLimitAsyncCounter](./rate-limit.types/interfaces/RateLimitAsyncCounter) *** ### RateLimitConfigs -Re-exports [RateLimitConfigs](./rate-limit.types/interfaces/RateLimitConfigs.md) +Re-exports [RateLimitConfigs](./rate-limit.types/interfaces/RateLimitConfigs) *** ### RateLimitCounter -Re-exports [RateLimitCounter](./rate-limit.types/interfaces/RateLimitCounter.md) +Re-exports [RateLimitCounter](./rate-limit.types/interfaces/RateLimitCounter) *** ### SimpleRateLimitCounter -Re-exports [SimpleRateLimitCounter](./simple-rate-limit-counter/classes/SimpleRateLimitCounter.md) +Re-exports [SimpleRateLimitCounter](./simple-rate-limit-counter/classes/SimpleRateLimitCounter) diff --git a/sdks/typescript/api/decorators/rate-limit/rate-limit.fn/functions/rateLimitFn.md b/sdks/typescript/api/decorators/rate-limit/rate-limit.fn/functions/rateLimitFn.md index fe8f79c7..57cc59f2 100644 --- a/sdks/typescript/api/decorators/rate-limit/rate-limit.fn/functions/rateLimitFn.md +++ b/sdks/typescript/api/decorators/rate-limit/rate-limit.fn/functions/rateLimitFn.md @@ -1,6 +1,6 @@ # Function: rateLimitFn() -> **rateLimitFn**\<`D`, `A`\>(`originalMethod`, `config`): [`Method`](../../../types/type-aliases/Method.md)\<`D` \| `undefined`, `A`\> +> **rateLimitFn**\<`D`, `A`\>(`originalMethod`, `config`): [`Method`](../../../types/type-aliases/Method)\<`D` \| `undefined`, `A`\> Defined in: [rate-limit/rate-limit.fn.ts:56](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/rate-limit/rate-limit.fn.ts#L56) @@ -24,19 +24,19 @@ The argument types of the original method ### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to rate limit ### config -[`RateLimitConfigs`](../../rate-limit.types/interfaces/RateLimitConfigs.md) +[`RateLimitConfigs`](../../rate-limit.types/interfaces/RateLimitConfigs) The rate limit configuration ## Returns -[`Method`](../../../types/type-aliases/Method.md)\<`D` \| `undefined`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D` \| `undefined`, `A`\> A rate-limited method diff --git a/sdks/typescript/api/decorators/rate-limit/rate-limit.fn/index.md b/sdks/typescript/api/decorators/rate-limit/rate-limit.fn/index.md index 781c1cb6..702f572f 100644 --- a/sdks/typescript/api/decorators/rate-limit/rate-limit.fn/index.md +++ b/sdks/typescript/api/decorators/rate-limit/rate-limit.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [rateLimitFn](./functions/rateLimitFn.md) +- [rateLimitFn](./functions/rateLimitFn) diff --git a/sdks/typescript/api/decorators/rate-limit/rate-limit.types/index.md b/sdks/typescript/api/decorators/rate-limit/rate-limit.types/index.md index ae6034ec..d8e9fb7d 100644 --- a/sdks/typescript/api/decorators/rate-limit/rate-limit.types/index.md +++ b/sdks/typescript/api/decorators/rate-limit/rate-limit.types/index.md @@ -2,10 +2,10 @@ ## Interfaces -- [RateLimitAsyncCounter](./interfaces/RateLimitAsyncCounter.md) -- [RateLimitConfigs](./interfaces/RateLimitConfigs.md) -- [RateLimitCounter](./interfaces/RateLimitCounter.md) +- [RateLimitAsyncCounter](./interfaces/RateLimitAsyncCounter) +- [RateLimitConfigs](./interfaces/RateLimitConfigs) +- [RateLimitCounter](./interfaces/RateLimitCounter) ## Type Aliases -- [RateLimitable](./type-aliases/RateLimitable.md) +- [RateLimitable](./type-aliases/RateLimitable) diff --git a/sdks/typescript/api/decorators/rate-limit/rate-limit.types/interfaces/RateLimitConfigs.md b/sdks/typescript/api/decorators/rate-limit/rate-limit.types/interfaces/RateLimitConfigs.md index 7b103b13..b0f7a8f9 100644 --- a/sdks/typescript/api/decorators/rate-limit/rate-limit.types/interfaces/RateLimitConfigs.md +++ b/sdks/typescript/api/decorators/rate-limit/rate-limit.types/interfaces/RateLimitConfigs.md @@ -63,7 +63,7 @@ Function to generate rate limit keys (for per-user/entity limiting) ### rateLimitAsyncCounter? -> `optional` **rateLimitAsyncCounter?**: [`RateLimitAsyncCounter`](./RateLimitAsyncCounter.md) +> `optional` **rateLimitAsyncCounter?**: [`RateLimitAsyncCounter`](./RateLimitAsyncCounter) Defined in: [rate-limit/rate-limit.types.ts:76](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/rate-limit/rate-limit.types.ts#L76) @@ -73,7 +73,7 @@ Async counter implementation ### rateLimitCounter? -> `optional` **rateLimitCounter?**: [`RateLimitCounter`](./RateLimitCounter.md) +> `optional` **rateLimitCounter?**: [`RateLimitCounter`](./RateLimitCounter) Defined in: [rate-limit/rate-limit.types.ts:74](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/rate-limit/rate-limit.types.ts#L74) diff --git a/sdks/typescript/api/decorators/rate-limit/rate-limit.types/type-aliases/RateLimitable.md b/sdks/typescript/api/decorators/rate-limit/rate-limit.types/type-aliases/RateLimitable.md index 2bd1152d..a1e4a348 100644 --- a/sdks/typescript/api/decorators/rate-limit/rate-limit.types/type-aliases/RateLimitable.md +++ b/sdks/typescript/api/decorators/rate-limit/rate-limit.types/type-aliases/RateLimitable.md @@ -1,6 +1,6 @@ # Type Alias: RateLimitable\ -> **RateLimitable**\<`T`, `D`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`D`\>\> +> **RateLimitable**\<`T`, `D`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`D`\>\> Defined in: [rate-limit/rate-limit.types.ts:170](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/rate-limit/rate-limit.types.ts#L170) @@ -36,13 +36,13 @@ The name of the method being decorated ### descriptor -`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`D`\>\> +`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`D`\>\> The property descriptor ## Returns -`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`D`\>\> +`TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`D`\>\> The modified descriptor diff --git a/sdks/typescript/api/decorators/rate-limit/rate-limit/functions/rateLimit.md b/sdks/typescript/api/decorators/rate-limit/rate-limit/functions/rateLimit.md index 9be94bfb..416eae3b 100644 --- a/sdks/typescript/api/decorators/rate-limit/rate-limit/functions/rateLimit.md +++ b/sdks/typescript/api/decorators/rate-limit/rate-limit/functions/rateLimit.md @@ -1,6 +1,6 @@ # Function: rateLimit() -> **rateLimit**\<`T`\>(`config`): (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`unknown`\>\> +> **rateLimit**\<`T`\>(`config`): (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`unknown`\>\> Defined in: [rate-limit/rate-limit.ts:71](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/rate-limit/rate-limit.ts#L71) @@ -19,7 +19,7 @@ The type of the class containing the decorated method ### config -[`RateLimitConfigs`](../../rate-limit.types/interfaces/RateLimitConfigs.md)\<`T`\> +[`RateLimitConfigs`](../../rate-limit.types/interfaces/RateLimitConfigs)\<`T`\> Rate limit configuration @@ -27,7 +27,7 @@ Rate limit configuration The decorator function -(`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method.md)\<`unknown`\>\> +(`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](../../../types/type-aliases/Method)\<`unknown`\>\> ## Throws diff --git a/sdks/typescript/api/decorators/rate-limit/rate-limit/index.md b/sdks/typescript/api/decorators/rate-limit/rate-limit/index.md index 5e43c9ca..615afa5a 100644 --- a/sdks/typescript/api/decorators/rate-limit/rate-limit/index.md +++ b/sdks/typescript/api/decorators/rate-limit/rate-limit/index.md @@ -2,4 +2,4 @@ ## Functions -- [rateLimit](./functions/rateLimit.md) +- [rateLimit](./functions/rateLimit) diff --git a/sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/classes/SimpleRateLimitCounter.md b/sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/classes/SimpleRateLimitCounter.md index a7adce87..f303dbf5 100644 --- a/sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/classes/SimpleRateLimitCounter.md +++ b/sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/classes/SimpleRateLimitCounter.md @@ -30,7 +30,7 @@ console.log(counter.getCount('user-1')); // 1 ## Implements -- [`RateLimitCounter`](../../rate-limit.types/interfaces/RateLimitCounter.md) +- [`RateLimitCounter`](../../rate-limit.types/interfaces/RateLimitCounter) ## Constructors @@ -91,7 +91,7 @@ console.log(counter.getCount('key')); // 0 (key removed from map) #### Implementation of -[`RateLimitCounter`](../../rate-limit.types/interfaces/RateLimitCounter.md).[`dec`](../../rate-limit.types/interfaces/RateLimitCounter.md#dec) +[`RateLimitCounter`](../../rate-limit.types/interfaces/RateLimitCounter).[`dec`](../../rate-limit.types/interfaces/RateLimitCounter#dec) *** @@ -128,7 +128,7 @@ console.log(counter.getCount('key')); // 1 #### Implementation of -[`RateLimitCounter`](../../rate-limit.types/interfaces/RateLimitCounter.md).[`getCount`](../../rate-limit.types/interfaces/RateLimitCounter.md#getcount) +[`RateLimitCounter`](../../rate-limit.types/interfaces/RateLimitCounter).[`getCount`](../../rate-limit.types/interfaces/RateLimitCounter#getcount) *** @@ -163,4 +163,4 @@ console.log(counter.getCount('user-123')); // 2 #### Implementation of -[`RateLimitCounter`](../../rate-limit.types/interfaces/RateLimitCounter.md).[`inc`](../../rate-limit.types/interfaces/RateLimitCounter.md#inc) +[`RateLimitCounter`](../../rate-limit.types/interfaces/RateLimitCounter).[`inc`](../../rate-limit.types/interfaces/RateLimitCounter#inc) diff --git a/sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/index.md b/sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/index.md index 56ca2a0f..dc4509c1 100644 --- a/sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/index.md +++ b/sdks/typescript/api/decorators/rate-limit/simple-rate-limit-counter/index.md @@ -2,4 +2,4 @@ ## Classes -- [SimpleRateLimitCounter](./classes/SimpleRateLimitCounter.md) +- [SimpleRateLimitCounter](./classes/SimpleRateLimitCounter) diff --git a/sdks/typescript/api/decorators/readonly/index.md b/sdks/typescript/api/decorators/readonly/index.md index 40f86b60..5c28b24d 100644 --- a/sdks/typescript/api/decorators/readonly/index.md +++ b/sdks/typescript/api/decorators/readonly/index.md @@ -4,10 +4,10 @@ ### readonly -Re-exports [readonly](./readonly/functions/readonly.md) +Re-exports [readonly](./readonly/functions/readonly) *** ### Readonlyable -Re-exports [Readonlyable](./readonly.types/type-aliases/Readonlyable.md) +Re-exports [Readonlyable](./readonly.types/type-aliases/Readonlyable) diff --git a/sdks/typescript/api/decorators/readonly/readonly.types/index.md b/sdks/typescript/api/decorators/readonly/readonly.types/index.md index 96e7d283..39495bad 100644 --- a/sdks/typescript/api/decorators/readonly/readonly.types/index.md +++ b/sdks/typescript/api/decorators/readonly/readonly.types/index.md @@ -2,4 +2,4 @@ ## Type Aliases -- [Readonlyable](./type-aliases/Readonlyable.md) +- [Readonlyable](./type-aliases/Readonlyable) diff --git a/sdks/typescript/api/decorators/readonly/readonly/functions/readonly.md b/sdks/typescript/api/decorators/readonly/readonly/functions/readonly.md index 5921ab94..69b1d996 100644 --- a/sdks/typescript/api/decorators/readonly/readonly/functions/readonly.md +++ b/sdks/typescript/api/decorators/readonly/readonly/functions/readonly.md @@ -1,6 +1,6 @@ # Function: readonly() -> **readonly**\<`T`\>(): [`Readonlyable`](../../readonly.types/type-aliases/Readonlyable.md)\<`T`\> +> **readonly**\<`T`\>(): [`Readonlyable`](../../readonly.types/type-aliases/Readonlyable)\<`T`\> Defined in: [readonly/readonly.ts:52](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/readonly/readonly.ts#L52) @@ -17,7 +17,7 @@ The type of the class containing the decorated method ## Returns -[`Readonlyable`](../../readonly.types/type-aliases/Readonlyable.md)\<`T`\> +[`Readonlyable`](../../readonly.types/type-aliases/Readonlyable)\<`T`\> The decorator function diff --git a/sdks/typescript/api/decorators/readonly/readonly/index.md b/sdks/typescript/api/decorators/readonly/readonly/index.md index 320237fc..0de94570 100644 --- a/sdks/typescript/api/decorators/readonly/readonly/index.md +++ b/sdks/typescript/api/decorators/readonly/readonly/index.md @@ -2,4 +2,4 @@ ## Functions -- [readonly](./functions/readonly.md) +- [readonly](./functions/readonly) diff --git a/sdks/typescript/api/decorators/throttle-async/index.md b/sdks/typescript/api/decorators/throttle-async/index.md index 26392fd9..c9ca5baa 100644 --- a/sdks/typescript/api/decorators/throttle-async/index.md +++ b/sdks/typescript/api/decorators/throttle-async/index.md @@ -4,4 +4,4 @@ ### throttleAsync -Re-exports [throttleAsync](./throttle-async/functions/throttleAsync.md) +Re-exports [throttleAsync](./throttle-async/functions/throttleAsync) diff --git a/sdks/typescript/api/decorators/throttle-async/throttle-async-executor/classes/ThrottleAsyncExecutor.md b/sdks/typescript/api/decorators/throttle-async/throttle-async-executor/classes/ThrottleAsyncExecutor.md index 088e4f5e..699bc1b3 100644 --- a/sdks/typescript/api/decorators/throttle-async/throttle-async-executor/classes/ThrottleAsyncExecutor.md +++ b/sdks/typescript/api/decorators/throttle-async/throttle-async-executor/classes/ThrottleAsyncExecutor.md @@ -50,7 +50,7 @@ Creates a new ThrottleAsyncExecutor instance. ##### fun -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`\> The async method to throttle diff --git a/sdks/typescript/api/decorators/throttle-async/throttle-async-executor/index.md b/sdks/typescript/api/decorators/throttle-async/throttle-async-executor/index.md index a2e956dc..5d4126aa 100644 --- a/sdks/typescript/api/decorators/throttle-async/throttle-async-executor/index.md +++ b/sdks/typescript/api/decorators/throttle-async/throttle-async-executor/index.md @@ -2,4 +2,4 @@ ## Classes -- [ThrottleAsyncExecutor](./classes/ThrottleAsyncExecutor.md) +- [ThrottleAsyncExecutor](./classes/ThrottleAsyncExecutor) diff --git a/sdks/typescript/api/decorators/throttle-async/throttle-async.fn/functions/throttleAsyncFn.md b/sdks/typescript/api/decorators/throttle-async/throttle-async.fn/functions/throttleAsyncFn.md index 162cbff9..fedd4072 100644 --- a/sdks/typescript/api/decorators/throttle-async/throttle-async.fn/functions/throttleAsyncFn.md +++ b/sdks/typescript/api/decorators/throttle-async/throttle-async.fn/functions/throttleAsyncFn.md @@ -1,6 +1,6 @@ # Function: throttleAsyncFn() -> **throttleAsyncFn**\<`D`, `A`\>(`originalMethod`, `parallelCalls?`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +> **throttleAsyncFn**\<`D`, `A`\>(`originalMethod`, `parallelCalls?`): [`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> Defined in: [throttle-async/throttle-async.fn.ts:54](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/throttle-async/throttle-async.fn.ts#L54) @@ -24,7 +24,7 @@ The argument types of the original method ### originalMethod -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The async method to throttle @@ -36,7 +36,7 @@ Maximum number of concurrent calls ## Returns -[`AsyncMethod`](../../../types/type-aliases/AsyncMethod.md)\<`D`, `A`\> +[`AsyncMethod`](../../../types/type-aliases/AsyncMethod)\<`D`, `A`\> The throttled async method diff --git a/sdks/typescript/api/decorators/throttle-async/throttle-async.fn/index.md b/sdks/typescript/api/decorators/throttle-async/throttle-async.fn/index.md index 332d7896..18b8f347 100644 --- a/sdks/typescript/api/decorators/throttle-async/throttle-async.fn/index.md +++ b/sdks/typescript/api/decorators/throttle-async/throttle-async.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [throttleAsyncFn](./functions/throttleAsyncFn.md) +- [throttleAsyncFn](./functions/throttleAsyncFn) diff --git a/sdks/typescript/api/decorators/throttle-async/throttle-async/functions/throttleAsync.md b/sdks/typescript/api/decorators/throttle-async/throttle-async/functions/throttleAsync.md index 3f98aacd..fd4c0854 100644 --- a/sdks/typescript/api/decorators/throttle-async/throttle-async/functions/throttleAsync.md +++ b/sdks/typescript/api/decorators/throttle-async/throttle-async/functions/throttleAsync.md @@ -1,6 +1,6 @@ # Function: throttleAsync() -> **throttleAsync**\<`T`, `D`\>(`parallelCalls?`): [`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +> **throttleAsync**\<`T`, `D`\>(`parallelCalls?`): [`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> Defined in: [throttle-async/throttle-async.ts:82](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/throttle-async/throttle-async.ts#L82) @@ -31,7 +31,7 @@ Maximum number of concurrent calls allowed ## Returns -[`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +[`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> The decorator function diff --git a/sdks/typescript/api/decorators/throttle-async/throttle-async/index.md b/sdks/typescript/api/decorators/throttle-async/throttle-async/index.md index b8309b5f..10c79fac 100644 --- a/sdks/typescript/api/decorators/throttle-async/throttle-async/index.md +++ b/sdks/typescript/api/decorators/throttle-async/throttle-async/index.md @@ -2,4 +2,4 @@ ## Functions -- [throttleAsync](./functions/throttleAsync.md) +- [throttleAsync](./functions/throttleAsync) diff --git a/sdks/typescript/api/decorators/throttle/index.md b/sdks/typescript/api/decorators/throttle/index.md index c2915cbb..f28b0d2c 100644 --- a/sdks/typescript/api/decorators/throttle/index.md +++ b/sdks/typescript/api/decorators/throttle/index.md @@ -4,4 +4,4 @@ ### throttle -Re-exports [throttle](./throttle/functions/throttle.md) +Re-exports [throttle](./throttle/functions/throttle) diff --git a/sdks/typescript/api/decorators/throttle/throttle.fn/functions/throttleFn.md b/sdks/typescript/api/decorators/throttle/throttle.fn/functions/throttleFn.md index f9a2639f..17ec61de 100644 --- a/sdks/typescript/api/decorators/throttle/throttle.fn/functions/throttleFn.md +++ b/sdks/typescript/api/decorators/throttle/throttle.fn/functions/throttleFn.md @@ -1,6 +1,6 @@ # Function: throttleFn() -> **throttleFn**\<`D`, `A`\>(`originalMethod`, `delayMs`): [`Method`](../../../types/type-aliases/Method.md)\<`void`, `A`\> +> **throttleFn**\<`D`, `A`\>(`originalMethod`, `delayMs`): [`Method`](../../../types/type-aliases/Method)\<`void`, `A`\> Defined in: [throttle/throttle.fn.ts:54](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/throttle/throttle.fn.ts#L54) @@ -24,7 +24,7 @@ The argument types of the original method ### originalMethod -[`Method`](../../../types/type-aliases/Method.md)\<`D`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`D`, `A`\> The method to throttle @@ -36,7 +36,7 @@ The throttle interval in milliseconds ## Returns -[`Method`](../../../types/type-aliases/Method.md)\<`void`, `A`\> +[`Method`](../../../types/type-aliases/Method)\<`void`, `A`\> The throttled method diff --git a/sdks/typescript/api/decorators/throttle/throttle.fn/index.md b/sdks/typescript/api/decorators/throttle/throttle.fn/index.md index ba7acf17..e6097106 100644 --- a/sdks/typescript/api/decorators/throttle/throttle.fn/index.md +++ b/sdks/typescript/api/decorators/throttle/throttle.fn/index.md @@ -2,4 +2,4 @@ ## Functions -- [throttleFn](./functions/throttleFn.md) +- [throttleFn](./functions/throttleFn) diff --git a/sdks/typescript/api/decorators/throttle/throttle/functions/throttle.md b/sdks/typescript/api/decorators/throttle/throttle/functions/throttle.md index fcd69477..c9a76d3b 100644 --- a/sdks/typescript/api/decorators/throttle/throttle/functions/throttle.md +++ b/sdks/typescript/api/decorators/throttle/throttle/functions/throttle.md @@ -1,6 +1,6 @@ # Function: throttle() -> **throttle**\<`T`\>(`delayMs`): [`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +> **throttle**\<`T`\>(`delayMs`): [`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> Defined in: [throttle/throttle.ts:48](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/throttle/throttle.ts#L48) @@ -24,7 +24,7 @@ The throttle interval in milliseconds ## Returns -[`Decorator`](../../../types/type-aliases/Decorator.md)\<`T`\> +[`Decorator`](../../../types/type-aliases/Decorator)\<`T`\> The decorator function diff --git a/sdks/typescript/api/decorators/throttle/throttle/index.md b/sdks/typescript/api/decorators/throttle/throttle/index.md index 7ddc12ca..5ed0ae09 100644 --- a/sdks/typescript/api/decorators/throttle/throttle/index.md +++ b/sdks/typescript/api/decorators/throttle/throttle/index.md @@ -2,4 +2,4 @@ ## Functions -- [throttle](./functions/throttle.md) +- [throttle](./functions/throttle) diff --git a/sdks/typescript/api/decorators/types/index.md b/sdks/typescript/api/decorators/types/index.md index 33394752..a535a2e2 100644 --- a/sdks/typescript/api/decorators/types/index.md +++ b/sdks/typescript/api/decorators/types/index.md @@ -2,7 +2,7 @@ ## Type Aliases -- [AsyncDecorator](./type-aliases/AsyncDecorator.md) -- [AsyncMethod](./type-aliases/AsyncMethod.md) -- [Decorator](./type-aliases/Decorator.md) -- [Method](./type-aliases/Method.md) +- [AsyncDecorator](./type-aliases/AsyncDecorator) +- [AsyncMethod](./type-aliases/AsyncMethod) +- [Decorator](./type-aliases/Decorator) +- [Method](./type-aliases/Method) diff --git a/sdks/typescript/api/decorators/types/type-aliases/AsyncDecorator.md b/sdks/typescript/api/decorators/types/type-aliases/AsyncDecorator.md index a971400d..9af758cf 100644 --- a/sdks/typescript/api/decorators/types/type-aliases/AsyncDecorator.md +++ b/sdks/typescript/api/decorators/types/type-aliases/AsyncDecorator.md @@ -1,6 +1,6 @@ # Type Alias: AsyncDecorator\ -> **AsyncDecorator**\<`T`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`AsyncMethod`](./AsyncMethod.md)\<`any`\>\> +> **AsyncDecorator**\<`T`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`AsyncMethod`](./AsyncMethod)\<`any`\>\> Defined in: [types.ts:89](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/types.ts#L89) @@ -26,11 +26,11 @@ keyof `T` ### descriptor -`TypedPropertyDescriptor`\<[`AsyncMethod`](./AsyncMethod.md)\<`any`\>\> +`TypedPropertyDescriptor`\<[`AsyncMethod`](./AsyncMethod)\<`any`\>\> ## Returns -`TypedPropertyDescriptor`\<[`AsyncMethod`](./AsyncMethod.md)\<`any`\>\> +`TypedPropertyDescriptor`\<[`AsyncMethod`](./AsyncMethod)\<`any`\>\> ## Example diff --git a/sdks/typescript/api/decorators/types/type-aliases/Decorator.md b/sdks/typescript/api/decorators/types/type-aliases/Decorator.md index b2201383..3f354599 100644 --- a/sdks/typescript/api/decorators/types/type-aliases/Decorator.md +++ b/sdks/typescript/api/decorators/types/type-aliases/Decorator.md @@ -1,6 +1,6 @@ # Type Alias: Decorator\ -> **Decorator**\<`T`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](./Method.md)\<`any`\>\> +> **Decorator**\<`T`\> = (`target`, `propertyName`, `descriptor`) => `TypedPropertyDescriptor`\<[`Method`](./Method)\<`any`\>\> Defined in: [types.ts:47](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/decorators/src/types.ts#L47) @@ -26,11 +26,11 @@ keyof `T` ### descriptor -`TypedPropertyDescriptor`\<[`Method`](./Method.md)\<`any`\>\> +`TypedPropertyDescriptor`\<[`Method`](./Method)\<`any`\>\> ## Returns -`TypedPropertyDescriptor`\<[`Method`](./Method.md)\<`any`\>\> +`TypedPropertyDescriptor`\<[`Method`](./Method)\<`any`\>\> ## Example diff --git a/sdks/typescript/api/decorators/utils/index.md b/sdks/typescript/api/decorators/utils/index.md index 0666715a..68be914e 100644 --- a/sdks/typescript/api/decorators/utils/index.md +++ b/sdks/typescript/api/decorators/utils/index.md @@ -2,16 +2,16 @@ ## Classes -- [Queue](./classes/Queue.md) -- [TaskExec](./classes/TaskExec.md) +- [Queue](./classes/Queue) +- [TaskExec](./classes/TaskExec) ## Variables -- [logger](./variables/logger.md) +- [logger](./variables/logger) ## Functions -- [isFunction](./functions/isFunction.md) -- [isNumber](./functions/isNumber.md) -- [isPromise](./functions/isPromise.md) -- [isString](./functions/isString.md) +- [isFunction](./functions/isFunction) +- [isNumber](./functions/isNumber) +- [isPromise](./functions/isPromise) +- [isString](./functions/isString) diff --git a/sdks/typescript/api/dsa/bloom/index.md b/sdks/typescript/api/dsa/bloom/index.md index abe0c79b..8af92fd3 100644 --- a/sdks/typescript/api/dsa/bloom/index.md +++ b/sdks/typescript/api/dsa/bloom/index.md @@ -2,4 +2,4 @@ ## Classes -- [BloomFilter](./classes/BloomFilter.md) +- [BloomFilter](./classes/BloomFilter) diff --git a/sdks/typescript/api/dsa/count-min/index.md b/sdks/typescript/api/dsa/count-min/index.md index ad4e348a..193d81f5 100644 --- a/sdks/typescript/api/dsa/count-min/index.md +++ b/sdks/typescript/api/dsa/count-min/index.md @@ -2,4 +2,4 @@ ## Classes -- [CountMinSketch](./classes/CountMinSketch.md) +- [CountMinSketch](./classes/CountMinSketch) diff --git a/sdks/typescript/api/dsa/distance/classes/Distance.md b/sdks/typescript/api/dsa/distance/classes/Distance.md index bb181871..b51e2a54 100644 --- a/sdks/typescript/api/dsa/distance/classes/Distance.md +++ b/sdks/typescript/api/dsa/distance/classes/Distance.md @@ -32,19 +32,19 @@ Defined in: [distance.ts:419](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### formula -[`DistanceFormula`](../type-aliases/DistanceFormula.md) +[`DistanceFormula`](../type-aliases/DistanceFormula) ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) \| [`Coordinates3D`](../interfaces/Coordinates3D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) \| [`Coordinates3D`](../interfaces/Coordinates3D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) \| [`Coordinates3D`](../interfaces/Coordinates3D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) \| [`Coordinates3D`](../interfaces/Coordinates3D) ##### options? -[`DistanceOptions`](../interfaces/DistanceOptions.md) = `{}` +[`DistanceOptions`](../interfaces/DistanceOptions) = `{}` #### Returns @@ -54,7 +54,7 @@ Defined in: [distance.ts:419](https://github.com/resq-software/npm/blob/f2ab5fc8 ### calculateSafe() -> `static` **calculateSafe**(`formula`, `point1`, `point2`, `options?`): [`DistanceResult`](../interfaces/DistanceResult.md) +> `static` **calculateSafe**(`formula`, `point1`, `point2`, `options?`): [`DistanceResult`](../interfaces/DistanceResult) Defined in: [distance.ts:455](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/distance.ts#L455) @@ -62,23 +62,23 @@ Defined in: [distance.ts:455](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### formula -[`DistanceFormula`](../type-aliases/DistanceFormula.md) +[`DistanceFormula`](../type-aliases/DistanceFormula) ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) \| [`Coordinates3D`](../interfaces/Coordinates3D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) \| [`Coordinates3D`](../interfaces/Coordinates3D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) \| [`Coordinates3D`](../interfaces/Coordinates3D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) \| [`Coordinates3D`](../interfaces/Coordinates3D) ##### options? -[`DistanceOptions`](../interfaces/DistanceOptions.md) = `{}` +[`DistanceOptions`](../interfaces/DistanceOptions) = `{}` #### Returns -[`DistanceResult`](../interfaces/DistanceResult.md) +[`DistanceResult`](../interfaces/DistanceResult) *** @@ -92,11 +92,11 @@ Defined in: [distance.ts:327](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -114,11 +114,11 @@ Defined in: [distance.ts:359](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -136,11 +136,11 @@ Defined in: [distance.ts:210](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -158,11 +158,11 @@ Defined in: [distance.ts:377](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -180,11 +180,11 @@ Defined in: [distance.ts:219](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -202,11 +202,11 @@ Defined in: [distance.ts:236](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -224,11 +224,11 @@ Defined in: [distance.ts:389](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -246,11 +246,11 @@ Defined in: [distance.ts:320](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -268,11 +268,11 @@ Defined in: [distance.ts:334](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### p? @@ -286,7 +286,7 @@ Defined in: [distance.ts:334](https://github.com/resq-software/npm/blob/f2ab5fc8 ### recommendGeoFormula() -> `static` **recommendGeoFormula**(`maxDistanceKm?`): [`DistanceFormula`](../type-aliases/DistanceFormula.md) +> `static` **recommendGeoFormula**(`maxDistanceKm?`): [`DistanceFormula`](../type-aliases/DistanceFormula) Defined in: [distance.ts:478](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/distance.ts#L478) @@ -298,7 +298,7 @@ Defined in: [distance.ts:478](https://github.com/resq-software/npm/blob/f2ab5fc8 #### Returns -[`DistanceFormula`](../type-aliases/DistanceFormula.md) +[`DistanceFormula`](../type-aliases/DistanceFormula) *** @@ -312,11 +312,11 @@ Defined in: [distance.ts:404](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns @@ -334,11 +334,11 @@ Defined in: [distance.ts:352](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates3D`](../interfaces/Coordinates3D.md) +[`Coordinates3D`](../interfaces/Coordinates3D) ##### point2 -[`Coordinates3D`](../interfaces/Coordinates3D.md) +[`Coordinates3D`](../interfaces/Coordinates3D) #### Returns @@ -356,11 +356,11 @@ Defined in: [distance.ts:240](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### point1 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) ##### point2 -[`Coordinates2D`](../interfaces/Coordinates2D.md) +[`Coordinates2D`](../interfaces/Coordinates2D) #### Returns diff --git a/sdks/typescript/api/dsa/distance/index.md b/sdks/typescript/api/dsa/distance/index.md index 2362f39b..f108780f 100644 --- a/sdks/typescript/api/dsa/distance/index.md +++ b/sdks/typescript/api/dsa/distance/index.md @@ -2,12 +2,12 @@ ## Geometry -- [Distance](./classes/Distance.md) +- [Distance](./classes/Distance) ## Types -- [Coordinates2D](./interfaces/Coordinates2D.md) -- [Coordinates3D](./interfaces/Coordinates3D.md) -- [DistanceOptions](./interfaces/DistanceOptions.md) -- [DistanceResult](./interfaces/DistanceResult.md) -- [DistanceFormula](./type-aliases/DistanceFormula.md) +- [Coordinates2D](./interfaces/Coordinates2D) +- [Coordinates3D](./interfaces/Coordinates3D) +- [DistanceOptions](./interfaces/DistanceOptions) +- [DistanceResult](./interfaces/DistanceResult) +- [DistanceFormula](./type-aliases/DistanceFormula) diff --git a/sdks/typescript/api/dsa/distance/interfaces/Coordinates2D.md b/sdks/typescript/api/dsa/distance/interfaces/Coordinates2D.md index 1c3f9d5f..446d488d 100644 --- a/sdks/typescript/api/dsa/distance/interfaces/Coordinates2D.md +++ b/sdks/typescript/api/dsa/distance/interfaces/Coordinates2D.md @@ -6,7 +6,7 @@ Defined in: [distance.ts:81](https://github.com/resq-software/npm/blob/f2ab5fc82 ## Extended by -- [`Coordinates3D`](./Coordinates3D.md) +- [`Coordinates3D`](./Coordinates3D) ## Properties diff --git a/sdks/typescript/api/dsa/distance/interfaces/Coordinates3D.md b/sdks/typescript/api/dsa/distance/interfaces/Coordinates3D.md index 3a4d95bb..b9718337 100644 --- a/sdks/typescript/api/dsa/distance/interfaces/Coordinates3D.md +++ b/sdks/typescript/api/dsa/distance/interfaces/Coordinates3D.md @@ -6,7 +6,7 @@ Defined in: [distance.ts:92](https://github.com/resq-software/npm/blob/f2ab5fc82 ## Extends -- [`Coordinates2D`](./Coordinates2D.md) +- [`Coordinates2D`](./Coordinates2D) ## Properties @@ -30,7 +30,7 @@ Latitude in degrees (-90 to 90) #### Inherited from -[`Coordinates2D`](./Coordinates2D.md).[`lat`](./Coordinates2D.md#lat) +[`Coordinates2D`](./Coordinates2D).[`lat`](./Coordinates2D#lat) *** @@ -44,4 +44,4 @@ Longitude in degrees (-180 to 180) #### Inherited from -[`Coordinates2D`](./Coordinates2D.md).[`lng`](./Coordinates2D.md#lng) +[`Coordinates2D`](./Coordinates2D).[`lng`](./Coordinates2D#lng) diff --git a/sdks/typescript/api/dsa/distance/interfaces/DistanceResult.md b/sdks/typescript/api/dsa/distance/interfaces/DistanceResult.md index 3706c967..a8d3f6fc 100644 --- a/sdks/typescript/api/dsa/distance/interfaces/DistanceResult.md +++ b/sdks/typescript/api/dsa/distance/interfaces/DistanceResult.md @@ -28,7 +28,7 @@ Error message if calculation failed ### formula -> **formula**: [`DistanceFormula`](../type-aliases/DistanceFormula.md) +> **formula**: [`DistanceFormula`](../type-aliases/DistanceFormula) Defined in: [distance.ts:120](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/distance.ts#L120) diff --git a/sdks/typescript/api/dsa/dsa/rabin-karp/classes/RabinKarp.md b/sdks/typescript/api/dsa/dsa/rabin-karp/classes/RabinKarp.md index 48621082..1a84fed5 100644 --- a/sdks/typescript/api/dsa/dsa/rabin-karp/classes/RabinKarp.md +++ b/sdks/typescript/api/dsa/dsa/rabin-karp/classes/RabinKarp.md @@ -43,7 +43,7 @@ Creates a new Rabin-Karp matcher ##### options? -[`RabinKarpOptions`](../interfaces/RabinKarpOptions.md) = `{}` +[`RabinKarpOptions`](../interfaces/RabinKarpOptions) = `{}` Configuration options @@ -96,7 +96,7 @@ Map of patterns to their occurrence count ### search() -> **search**(`text`, `pattern`): [`PatternMatch`](../interfaces/PatternMatch.md)[] +> **search**(`text`, `pattern`): [`PatternMatch`](../interfaces/PatternMatch)[] Defined in: [rabin-karp.ts:152](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/rabin-karp.ts#L152) @@ -118,7 +118,7 @@ The pattern to search for #### Returns -[`PatternMatch`](../interfaces/PatternMatch.md)[] +[`PatternMatch`](../interfaces/PatternMatch)[] Array of matches found @@ -126,7 +126,7 @@ Array of matches found ### searchMultiple() -> **searchMultiple**(`text`, `patterns`): `Map`\<`string`, [`PatternMatch`](../interfaces/PatternMatch.md)[]\> +> **searchMultiple**(`text`, `patterns`): `Map`\<`string`, [`PatternMatch`](../interfaces/PatternMatch)[]\> Defined in: [rabin-karp.ts:225](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/rabin-karp.ts#L225) @@ -148,7 +148,7 @@ Array of patterns to search for #### Returns -`Map`\<`string`, [`PatternMatch`](../interfaces/PatternMatch.md)[]\> +`Map`\<`string`, [`PatternMatch`](../interfaces/PatternMatch)[]\> Map of pattern to matches @@ -184,8 +184,8 @@ Object containing matches and statistics ##### matches -> **matches**: [`PatternMatch`](../interfaces/PatternMatch.md)[] +> **matches**: [`PatternMatch`](../interfaces/PatternMatch)[] ##### stats -> **stats**: [`SearchStats`](../interfaces/SearchStats.md) +> **stats**: [`SearchStats`](../interfaces/SearchStats) diff --git a/sdks/typescript/api/dsa/dsa/rabin-karp/index.md b/sdks/typescript/api/dsa/dsa/rabin-karp/index.md index 28cac56d..1371bfb6 100644 --- a/sdks/typescript/api/dsa/dsa/rabin-karp/index.md +++ b/sdks/typescript/api/dsa/dsa/rabin-karp/index.md @@ -11,14 +11,14 @@ Efficient pattern matching using rolling hash for document search. ## Classes -- [RabinKarp](./classes/RabinKarp.md) +- [RabinKarp](./classes/RabinKarp) ## Interfaces -- [PatternMatch](./interfaces/PatternMatch.md) -- [RabinKarpOptions](./interfaces/RabinKarpOptions.md) -- [SearchStats](./interfaces/SearchStats.md) +- [PatternMatch](./interfaces/PatternMatch) +- [RabinKarpOptions](./interfaces/RabinKarpOptions) +- [SearchStats](./interfaces/SearchStats) ## Functions -- [quickSearch](./functions/quickSearch.md) +- [quickSearch](./functions/quickSearch) diff --git a/sdks/typescript/api/dsa/graph/classes/Graph.md b/sdks/typescript/api/dsa/graph/classes/Graph.md index 61be7120..0bf94e24 100644 --- a/sdks/typescript/api/dsa/graph/classes/Graph.md +++ b/sdks/typescript/api/dsa/graph/classes/Graph.md @@ -50,7 +50,7 @@ Creates a new Graph ##### options? -[`GraphOptions`](../interfaces/GraphOptions.md) = `{}` +[`GraphOptions`](../interfaces/GraphOptions) = `{}` Configuration options @@ -216,7 +216,7 @@ Path and cost, or null if no path exists ### bfs() -> **bfs**(`start`): [`TraversalResult`](../interfaces/TraversalResult.md)\<`T`\> +> **bfs**(`start`): [`TraversalResult`](../interfaces/TraversalResult)\<`T`\> Defined in: [graph.ts:288](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/graph.ts#L288) @@ -232,7 +232,7 @@ Starting vertex #### Returns -[`TraversalResult`](../interfaces/TraversalResult.md)\<`T`\> +[`TraversalResult`](../interfaces/TraversalResult)\<`T`\> Traversal result with vertices, parents, and distances @@ -254,7 +254,7 @@ Clears all vertices and edges ### dfs() -> **dfs**(`start`): [`TraversalResult`](../interfaces/TraversalResult.md)\<`T`\> +> **dfs**(`start`): [`TraversalResult`](../interfaces/TraversalResult)\<`T`\> Defined in: [graph.ts:329](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/graph.ts#L329) @@ -270,7 +270,7 @@ Starting vertex #### Returns -[`TraversalResult`](../interfaces/TraversalResult.md)\<`T`\> +[`TraversalResult`](../interfaces/TraversalResult)\<`T`\> Traversal result with vertices and parents @@ -314,7 +314,7 @@ Array of all paths found ### findShortestPath() -> **findShortestPath**(`start`, `end`): [`PathResult`](../interfaces/PathResult.md)\<`T`\> +> **findShortestPath**(`start`, `end`): [`PathResult`](../interfaces/PathResult)\<`T`\> Defined in: [graph.ts:365](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/graph.ts#L365) @@ -336,7 +336,7 @@ Ending vertex #### Returns -[`PathResult`](../interfaces/PathResult.md)\<`T`\> +[`PathResult`](../interfaces/PathResult)\<`T`\> Path result with vertices and total distance @@ -360,7 +360,7 @@ Array of connected components (each component is an array of vertices) ### getNeighbors() -> **getNeighbors**(`vertex`): [`Edge`](../interfaces/Edge.md)\<`T`\>[] +> **getNeighbors**(`vertex`): [`Edge`](../interfaces/Edge)\<`T`\>[] Defined in: [graph.ts:264](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/graph.ts#L264) @@ -374,7 +374,7 @@ Gets all neighbors of a vertex #### Returns -[`Edge`](../interfaces/Edge.md)\<`T`\>[] +[`Edge`](../interfaces/Edge)\<`T`\>[] *** diff --git a/sdks/typescript/api/dsa/graph/functions/addValidatedEdge.md b/sdks/typescript/api/dsa/graph/functions/addValidatedEdge.md index a43cd20b..b6e26f17 100644 --- a/sdks/typescript/api/dsa/graph/functions/addValidatedEdge.md +++ b/sdks/typescript/api/dsa/graph/functions/addValidatedEdge.md @@ -10,7 +10,7 @@ Validates and adds an edge using Effect Schema (for string graphs) ### graph -[`Graph`](../classes/Graph.md)\<`string`\> +[`Graph`](../classes/Graph)\<`string`\> ### source diff --git a/sdks/typescript/api/dsa/graph/index.md b/sdks/typescript/api/dsa/graph/index.md index 53327d6d..d914547a 100644 --- a/sdks/typescript/api/dsa/graph/index.md +++ b/sdks/typescript/api/dsa/graph/index.md @@ -2,17 +2,17 @@ ## Classes -- [Graph](./classes/Graph.md) +- [Graph](./classes/Graph) ## Interfaces -- [Edge](./interfaces/Edge.md) -- [GraphOptions](./interfaces/GraphOptions.md) -- [PathResult](./interfaces/PathResult.md) -- [TraversalResult](./interfaces/TraversalResult.md) -- [Vertex](./interfaces/Vertex.md) +- [Edge](./interfaces/Edge) +- [GraphOptions](./interfaces/GraphOptions) +- [PathResult](./interfaces/PathResult) +- [TraversalResult](./interfaces/TraversalResult) +- [Vertex](./interfaces/Vertex) ## Functions -- [addValidatedEdge](./functions/addValidatedEdge.md) -- [isValidVertexId](./functions/isValidVertexId.md) +- [addValidatedEdge](./functions/addValidatedEdge) +- [isValidVertexId](./functions/isValidVertexId) diff --git a/sdks/typescript/api/dsa/graph/interfaces/Vertex.md b/sdks/typescript/api/dsa/graph/interfaces/Vertex.md index a1c91ce5..dd87db41 100644 --- a/sdks/typescript/api/dsa/graph/interfaces/Vertex.md +++ b/sdks/typescript/api/dsa/graph/interfaces/Vertex.md @@ -14,7 +14,7 @@ Vertex with adjacency list ### edges -> **edges**: [`Edge`](./Edge.md)\<`T`\>[] +> **edges**: [`Edge`](./Edge)\<`T`\>[] Defined in: [graph.ts:49](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/graph.ts#L49) diff --git a/sdks/typescript/api/dsa/heap/classes/BoundedHeap.md b/sdks/typescript/api/dsa/heap/classes/BoundedHeap.md index 95f7f3fd..ffb4aa23 100644 --- a/sdks/typescript/api/dsa/heap/classes/BoundedHeap.md +++ b/sdks/typescript/api/dsa/heap/classes/BoundedHeap.md @@ -6,7 +6,7 @@ Defined in: [heap.ts:21](https://github.com/resq-software/npm/blob/f2ab5fc82f4f5 ### T -`T` *extends* [`Distanced`](../interfaces/Distanced.md) +`T` *extends* [`Distanced`](../interfaces/Distanced) ## Constructors diff --git a/sdks/typescript/api/dsa/heap/index.md b/sdks/typescript/api/dsa/heap/index.md index 3aa22346..0e0190f5 100644 --- a/sdks/typescript/api/dsa/heap/index.md +++ b/sdks/typescript/api/dsa/heap/index.md @@ -2,8 +2,8 @@ ## Classes -- [BoundedHeap](./classes/BoundedHeap.md) +- [BoundedHeap](./classes/BoundedHeap) ## Interfaces -- [Distanced](./interfaces/Distanced.md) +- [Distanced](./interfaces/Distanced) diff --git a/sdks/typescript/api/dsa/index.md b/sdks/typescript/api/dsa/index.md index 158a6102..6370f82a 100644 --- a/sdks/typescript/api/dsa/index.md +++ b/sdks/typescript/api/dsa/index.md @@ -2,15 +2,15 @@ ## Modules -- [bloom](./bloom/index.md) -- [count-min](./count-min/index.md) -- [distance](./distance/index.md) -- [dsa/rabin-karp](./dsa/rabin-karp/index.md) -- [graph](./graph/index.md) -- [heap](./heap/index.md) -- [index](./index/index.md) -- [lru-cache](./lru-cache/index.md) -- [priority-queue](./priority-queue/index.md) -- [queue](./queue/index.md) -- [schemas](./schemas/index.md) -- [trie](./trie/index.md) +- [bloom](./bloom) +- [count-min](./count-min) +- [distance](./distance) +- [dsa/rabin-karp](./dsa/rabin-karp) +- [graph](./graph) +- [heap](./heap) +- [index](./index) +- [lru-cache](./lru-cache) +- [priority-queue](./priority-queue) +- [queue](./queue) +- [schemas](./schemas) +- [trie](./trie) diff --git a/sdks/typescript/api/dsa/index/index.md b/sdks/typescript/api/dsa/index/index.md index b1f8bcf5..c503bf92 100644 --- a/sdks/typescript/api/dsa/index/index.md +++ b/sdks/typescript/api/dsa/index/index.md @@ -4,214 +4,214 @@ ### addValidatedEdge -Re-exports [addValidatedEdge](../graph/functions/addValidatedEdge.md) +Re-exports [addValidatedEdge](../graph/functions/addValidatedEdge) *** ### BloomFilter -Re-exports [BloomFilter](../bloom/classes/BloomFilter.md) +Re-exports [BloomFilter](../bloom/classes/BloomFilter) *** ### BoundedHeap -Re-exports [BoundedHeap](../heap/classes/BoundedHeap.md) +Re-exports [BoundedHeap](../heap/classes/BoundedHeap) *** ### CompareFn -Re-exports [CompareFn](../priority-queue/type-aliases/CompareFn.md) +Re-exports [CompareFn](../priority-queue/type-aliases/CompareFn) *** ### CountMinSketch -Re-exports [CountMinSketch](../count-min/classes/CountMinSketch.md) +Re-exports [CountMinSketch](../count-min/classes/CountMinSketch) *** ### createDeadlineQueue -Re-exports [createDeadlineQueue](../priority-queue/functions/createDeadlineQueue.md) +Re-exports [createDeadlineQueue](../priority-queue/functions/createDeadlineQueue) *** ### createMaxHeap -Re-exports [createMaxHeap](../priority-queue/functions/createMaxHeap.md) +Re-exports [createMaxHeap](../priority-queue/functions/createMaxHeap) *** ### createMinHeap -Re-exports [createMinHeap](../priority-queue/functions/createMinHeap.md) +Re-exports [createMinHeap](../priority-queue/functions/createMinHeap) *** ### createPriorityLevelQueue -Re-exports [createPriorityLevelQueue](../priority-queue/functions/createPriorityLevelQueue.md) +Re-exports [createPriorityLevelQueue](../priority-queue/functions/createPriorityLevelQueue) *** ### Distance -Re-exports [Distance](../distance/classes/Distance.md) +Re-exports [Distance](../distance/classes/Distance) *** ### Distanced -Re-exports [Distanced](../heap/interfaces/Distanced.md) +Re-exports [Distanced](../heap/interfaces/Distanced) *** ### Edge -Re-exports [Edge](../graph/interfaces/Edge.md) +Re-exports [Edge](../graph/interfaces/Edge) *** ### Graph -Re-exports [Graph](../graph/classes/Graph.md) +Re-exports [Graph](../graph/classes/Graph) *** ### GraphOptions -Re-exports [GraphOptions](../graph/interfaces/GraphOptions.md) +Re-exports [GraphOptions](../graph/interfaces/GraphOptions) *** ### isValidVertexId -Re-exports [isValidVertexId](../graph/functions/isValidVertexId.md) +Re-exports [isValidVertexId](../graph/functions/isValidVertexId) *** ### LRUCache -Re-exports [LRUCache](../lru-cache/classes/LRUCache.md) +Re-exports [LRUCache](../lru-cache/classes/LRUCache) *** ### LRUCacheOptions -Re-exports [LRUCacheOptions](../lru-cache/interfaces/LRUCacheOptions.md) +Re-exports [LRUCacheOptions](../lru-cache/interfaces/LRUCacheOptions) *** ### PathResult -Re-exports [PathResult](../graph/interfaces/PathResult.md) +Re-exports [PathResult](../graph/interfaces/PathResult) *** ### PatternMatch -Re-exports [PatternMatch](../dsa/rabin-karp/interfaces/PatternMatch.md) +Re-exports [PatternMatch](../dsa/rabin-karp/interfaces/PatternMatch) *** ### PriorityQueue -Re-exports [PriorityQueue](../priority-queue/classes/PriorityQueue.md) +Re-exports [PriorityQueue](../priority-queue/classes/PriorityQueue) *** ### PriorityQueueOptions -Re-exports [PriorityQueueOptions](../priority-queue/interfaces/PriorityQueueOptions.md) +Re-exports [PriorityQueueOptions](../priority-queue/interfaces/PriorityQueueOptions) *** ### PriorityQueueStats -Re-exports [PriorityQueueStats](../priority-queue/interfaces/PriorityQueueStats.md) +Re-exports [PriorityQueueStats](../priority-queue/interfaces/PriorityQueueStats) *** ### PriorityRequestItem -Re-exports [PriorityRequestItem](../priority-queue/interfaces/PriorityRequestItem.md) +Re-exports [PriorityRequestItem](../priority-queue/interfaces/PriorityRequestItem) *** ### Queue -Re-exports [Queue](../queue/classes/Queue.md) +Re-exports [Queue](../queue/classes/Queue) *** ### QueueNode -Re-exports [QueueNode](../queue/interfaces/QueueNode.md) +Re-exports [QueueNode](../queue/interfaces/QueueNode) *** ### quickSearch -Re-exports [quickSearch](../dsa/rabin-karp/functions/quickSearch.md) +Re-exports [quickSearch](../dsa/rabin-karp/functions/quickSearch) *** ### rabinKarp -Re-exports [rabinKarp](../trie/functions/rabinKarp.md) +Re-exports [rabinKarp](../trie/functions/rabinKarp) *** ### RabinKarp -Re-exports [RabinKarp](../dsa/rabin-karp/classes/RabinKarp.md) +Re-exports [RabinKarp](../dsa/rabin-karp/classes/RabinKarp) *** ### RabinKarpOptions -Re-exports [RabinKarpOptions](../dsa/rabin-karp/interfaces/RabinKarpOptions.md) +Re-exports [RabinKarpOptions](../dsa/rabin-karp/interfaces/RabinKarpOptions) *** ### SearchStats -Re-exports [SearchStats](../dsa/rabin-karp/interfaces/SearchStats.md) +Re-exports [SearchStats](../dsa/rabin-karp/interfaces/SearchStats) *** ### TraversalResult -Re-exports [TraversalResult](../graph/interfaces/TraversalResult.md) +Re-exports [TraversalResult](../graph/interfaces/TraversalResult) *** ### Trie -Re-exports [Trie](../trie/classes/Trie.md) +Re-exports [Trie](../trie/classes/Trie) *** ### TrieOptions -Re-exports [TrieOptions](../schemas/type-aliases/TrieOptions.md) +Re-exports [TrieOptions](../schemas/type-aliases/TrieOptions) *** ### TrieSearchResult -Re-exports [TrieSearchResult](../trie/interfaces/TrieSearchResult.md) +Re-exports [TrieSearchResult](../trie/interfaces/TrieSearchResult) *** ### validatePriorityItem -Re-exports [validatePriorityItem](../priority-queue/functions/validatePriorityItem.md) +Re-exports [validatePriorityItem](../priority-queue/functions/validatePriorityItem) *** ### Vertex -Re-exports [Vertex](../graph/interfaces/Vertex.md) +Re-exports [Vertex](../graph/interfaces/Vertex) diff --git a/sdks/typescript/api/dsa/lru-cache/classes/LRUCache.md b/sdks/typescript/api/dsa/lru-cache/classes/LRUCache.md index 9d2dd6b2..cc37cd5c 100644 --- a/sdks/typescript/api/dsa/lru-cache/classes/LRUCache.md +++ b/sdks/typescript/api/dsa/lru-cache/classes/LRUCache.md @@ -32,7 +32,7 @@ Defined in: [lru-cache.ts:56](https://github.com/resq-software/npm/blob/f2ab5fc8 ##### options -[`LRUCacheOptions`](../interfaces/LRUCacheOptions.md) +[`LRUCacheOptions`](../interfaces/LRUCacheOptions) #### Returns diff --git a/sdks/typescript/api/dsa/lru-cache/index.md b/sdks/typescript/api/dsa/lru-cache/index.md index 2a81b4d4..bc287c75 100644 --- a/sdks/typescript/api/dsa/lru-cache/index.md +++ b/sdks/typescript/api/dsa/lru-cache/index.md @@ -2,8 +2,8 @@ ## Classes -- [LRUCache](./classes/LRUCache.md) +- [LRUCache](./classes/LRUCache) ## Interfaces -- [LRUCacheOptions](./interfaces/LRUCacheOptions.md) +- [LRUCacheOptions](./interfaces/LRUCacheOptions) diff --git a/sdks/typescript/api/dsa/priority-queue/classes/PriorityQueue.md b/sdks/typescript/api/dsa/priority-queue/classes/PriorityQueue.md index 376b4735..104e4ebf 100644 --- a/sdks/typescript/api/dsa/priority-queue/classes/PriorityQueue.md +++ b/sdks/typescript/api/dsa/priority-queue/classes/PriorityQueue.md @@ -53,7 +53,7 @@ Creates a new Priority Queue ##### options? -[`PriorityQueueOptions`](../interfaces/PriorityQueueOptions.md)\<`T`\> = `{}` +[`PriorityQueueOptions`](../interfaces/PriorityQueueOptions)\<`T`\> = `{}` Configuration options @@ -225,7 +225,7 @@ This queue for chaining ### getStats() -> **getStats**(): [`PriorityQueueStats`](../interfaces/PriorityQueueStats.md) +> **getStats**(): [`PriorityQueueStats`](../interfaces/PriorityQueueStats) Defined in: [priority-queue.ts:296](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/priority-queue.ts#L296) @@ -233,7 +233,7 @@ Gets queue statistics #### Returns -[`PriorityQueueStats`](../interfaces/PriorityQueueStats.md) +[`PriorityQueueStats`](../interfaces/PriorityQueueStats) Queue statistics @@ -378,7 +378,7 @@ Elements to add ##### options? -[`PriorityQueueOptions`](../interfaces/PriorityQueueOptions.md)\<`T`\> = `{}` +[`PriorityQueueOptions`](../interfaces/PriorityQueueOptions)\<`T`\> = `{}` Queue options diff --git a/sdks/typescript/api/dsa/priority-queue/functions/createDeadlineQueue.md b/sdks/typescript/api/dsa/priority-queue/functions/createDeadlineQueue.md index 82c2538e..b3979217 100644 --- a/sdks/typescript/api/dsa/priority-queue/functions/createDeadlineQueue.md +++ b/sdks/typescript/api/dsa/priority-queue/functions/createDeadlineQueue.md @@ -1,9 +1,9 @@ # Function: createDeadlineQueue() -> **createDeadlineQueue**(): [`PriorityQueue`](../classes/PriorityQueue.md)\<[`PriorityRequestItem`](../interfaces/PriorityRequestItem.md)\> +> **createDeadlineQueue**(): [`PriorityQueue`](../classes/PriorityQueue)\<[`PriorityRequestItem`](../interfaces/PriorityRequestItem)\> Defined in: [priority-queue.ts:436](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/priority-queue.ts#L436) ## Returns -[`PriorityQueue`](../classes/PriorityQueue.md)\<[`PriorityRequestItem`](../interfaces/PriorityRequestItem.md)\> +[`PriorityQueue`](../classes/PriorityQueue)\<[`PriorityRequestItem`](../interfaces/PriorityRequestItem)\> diff --git a/sdks/typescript/api/dsa/priority-queue/functions/createMaxHeap.md b/sdks/typescript/api/dsa/priority-queue/functions/createMaxHeap.md index 838b4356..df35be21 100644 --- a/sdks/typescript/api/dsa/priority-queue/functions/createMaxHeap.md +++ b/sdks/typescript/api/dsa/priority-queue/functions/createMaxHeap.md @@ -1,6 +1,6 @@ # Function: createMaxHeap() -> **createMaxHeap**\<`T`\>(): [`PriorityQueue`](../classes/PriorityQueue.md)\<`T`\> +> **createMaxHeap**\<`T`\>(): [`PriorityQueue`](../classes/PriorityQueue)\<`T`\> Defined in: [priority-queue.ts:466](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/priority-queue.ts#L466) @@ -14,6 +14,6 @@ Creates a max-heap priority queue (highest value = highest priority) ## Returns -[`PriorityQueue`](../classes/PriorityQueue.md)\<`T`\> +[`PriorityQueue`](../classes/PriorityQueue)\<`T`\> Max-heap priority queue diff --git a/sdks/typescript/api/dsa/priority-queue/functions/createMinHeap.md b/sdks/typescript/api/dsa/priority-queue/functions/createMinHeap.md index 44c65e57..7c51e221 100644 --- a/sdks/typescript/api/dsa/priority-queue/functions/createMinHeap.md +++ b/sdks/typescript/api/dsa/priority-queue/functions/createMinHeap.md @@ -1,6 +1,6 @@ # Function: createMinHeap() -> **createMinHeap**\<`T`\>(): [`PriorityQueue`](../classes/PriorityQueue.md)\<`T`\> +> **createMinHeap**\<`T`\>(): [`PriorityQueue`](../classes/PriorityQueue)\<`T`\> Defined in: [priority-queue.ts:482](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/priority-queue.ts#L482) @@ -14,6 +14,6 @@ Creates a min-heap priority queue (lowest value = highest priority) ## Returns -[`PriorityQueue`](../classes/PriorityQueue.md)\<`T`\> +[`PriorityQueue`](../classes/PriorityQueue)\<`T`\> Min-heap priority queue diff --git a/sdks/typescript/api/dsa/priority-queue/functions/createPriorityLevelQueue.md b/sdks/typescript/api/dsa/priority-queue/functions/createPriorityLevelQueue.md index 7d709318..a1c46ee8 100644 --- a/sdks/typescript/api/dsa/priority-queue/functions/createPriorityLevelQueue.md +++ b/sdks/typescript/api/dsa/priority-queue/functions/createPriorityLevelQueue.md @@ -1,6 +1,6 @@ # Function: createPriorityLevelQueue() -> **createPriorityLevelQueue**(): [`PriorityQueue`](../classes/PriorityQueue.md)\<[`PriorityRequestItem`](../interfaces/PriorityRequestItem.md)\> +> **createPriorityLevelQueue**(): [`PriorityQueue`](../classes/PriorityQueue)\<[`PriorityRequestItem`](../interfaces/PriorityRequestItem)\> Defined in: [priority-queue.ts:448](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/priority-queue.ts#L448) @@ -9,6 +9,6 @@ Lower priority number = higher priority ## Returns -[`PriorityQueue`](../classes/PriorityQueue.md)\<[`PriorityRequestItem`](../interfaces/PriorityRequestItem.md)\> +[`PriorityQueue`](../classes/PriorityQueue)\<[`PriorityRequestItem`](../interfaces/PriorityRequestItem)\> Priority queue that prioritizes by priority level, then deadline diff --git a/sdks/typescript/api/dsa/priority-queue/index.md b/sdks/typescript/api/dsa/priority-queue/index.md index 07c437ab..a8f2ccad 100644 --- a/sdks/typescript/api/dsa/priority-queue/index.md +++ b/sdks/typescript/api/dsa/priority-queue/index.md @@ -2,22 +2,22 @@ ## Classes -- [PriorityQueue](./classes/PriorityQueue.md) +- [PriorityQueue](./classes/PriorityQueue) ## Interfaces -- [PriorityQueueOptions](./interfaces/PriorityQueueOptions.md) -- [PriorityQueueStats](./interfaces/PriorityQueueStats.md) -- [PriorityRequestItem](./interfaces/PriorityRequestItem.md) +- [PriorityQueueOptions](./interfaces/PriorityQueueOptions) +- [PriorityQueueStats](./interfaces/PriorityQueueStats) +- [PriorityRequestItem](./interfaces/PriorityRequestItem) ## Type Aliases -- [CompareFn](./type-aliases/CompareFn.md) +- [CompareFn](./type-aliases/CompareFn) ## Functions -- [createDeadlineQueue](./functions/createDeadlineQueue.md) -- [createMaxHeap](./functions/createMaxHeap.md) -- [createMinHeap](./functions/createMinHeap.md) -- [createPriorityLevelQueue](./functions/createPriorityLevelQueue.md) -- [validatePriorityItem](./functions/validatePriorityItem.md) +- [createDeadlineQueue](./functions/createDeadlineQueue) +- [createMaxHeap](./functions/createMaxHeap) +- [createMinHeap](./functions/createMinHeap) +- [createPriorityLevelQueue](./functions/createPriorityLevelQueue) +- [validatePriorityItem](./functions/validatePriorityItem) diff --git a/sdks/typescript/api/dsa/priority-queue/interfaces/PriorityQueueOptions.md b/sdks/typescript/api/dsa/priority-queue/interfaces/PriorityQueueOptions.md index cdb8d416..f34257c9 100644 --- a/sdks/typescript/api/dsa/priority-queue/interfaces/PriorityQueueOptions.md +++ b/sdks/typescript/api/dsa/priority-queue/interfaces/PriorityQueueOptions.md @@ -14,7 +14,7 @@ Options for priority queue configuration ### compareFn? -> `optional` **compareFn?**: [`CompareFn`](../type-aliases/CompareFn.md)\<`T`\> +> `optional` **compareFn?**: [`CompareFn`](../type-aliases/CompareFn)\<`T`\> Defined in: [priority-queue.ts:45](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/priority-queue.ts#L45) diff --git a/sdks/typescript/api/dsa/queue/index.md b/sdks/typescript/api/dsa/queue/index.md index 4b03459e..1547a7b8 100644 --- a/sdks/typescript/api/dsa/queue/index.md +++ b/sdks/typescript/api/dsa/queue/index.md @@ -2,8 +2,8 @@ ## Classes -- [Queue](./classes/Queue.md) +- [Queue](./classes/Queue) ## Interfaces -- [QueueNode](./interfaces/QueueNode.md) +- [QueueNode](./interfaces/QueueNode) diff --git a/sdks/typescript/api/dsa/schemas/index.md b/sdks/typescript/api/dsa/schemas/index.md index c06af340..860856ac 100644 --- a/sdks/typescript/api/dsa/schemas/index.md +++ b/sdks/typescript/api/dsa/schemas/index.md @@ -2,34 +2,34 @@ ## Type Aliases -- [GraphEdge](./type-aliases/GraphEdge.md) -- [GraphOptions](./type-aliases/GraphOptions.md) -- [PriorityItemInput](./type-aliases/PriorityItemInput.md) -- [PriorityQueueOptions](./type-aliases/PriorityQueueOptions.md) -- [RabinKarpMultiSearch](./type-aliases/RabinKarpMultiSearch.md) -- [RabinKarpOptions](./type-aliases/RabinKarpOptions.md) -- [RabinKarpSearch](./type-aliases/RabinKarpSearch.md) -- [TrieInsert](./type-aliases/TrieInsert.md) -- [TrieOptions](./type-aliases/TrieOptions.md) -- [TrieSearch](./type-aliases/TrieSearch.md) -- [VertexId](./type-aliases/VertexId.md) +- [GraphEdge](./type-aliases/GraphEdge) +- [GraphOptions](./type-aliases/GraphOptions) +- [PriorityItemInput](./type-aliases/PriorityItemInput) +- [PriorityQueueOptions](./type-aliases/PriorityQueueOptions) +- [RabinKarpMultiSearch](./type-aliases/RabinKarpMultiSearch) +- [RabinKarpOptions](./type-aliases/RabinKarpOptions) +- [RabinKarpSearch](./type-aliases/RabinKarpSearch) +- [TrieInsert](./type-aliases/TrieInsert) +- [TrieOptions](./type-aliases/TrieOptions) +- [TrieSearch](./type-aliases/TrieSearch) +- [VertexId](./type-aliases/VertexId) ## Variables -- [GraphEdgeSchema](./variables/GraphEdgeSchema.md) -- [GraphOptionsSchema](./variables/GraphOptionsSchema.md) -- [PriorityItemSchema](./variables/PriorityItemSchema.md) -- [PriorityQueueOptionsSchema](./variables/PriorityQueueOptionsSchema.md) -- [RabinKarpMultiSearchSchema](./variables/RabinKarpMultiSearchSchema.md) -- [RabinKarpOptionsSchema](./variables/RabinKarpOptionsSchema.md) -- [RabinKarpSearchSchema](./variables/RabinKarpSearchSchema.md) -- [TrieInsertSchema](./variables/TrieInsertSchema.md) -- [TrieOptionsSchema](./variables/TrieOptionsSchema.md) -- [TrieSearchSchema](./variables/TrieSearchSchema.md) -- [VertexIdSchema](./variables/VertexIdSchema.md) +- [GraphEdgeSchema](./variables/GraphEdgeSchema) +- [GraphOptionsSchema](./variables/GraphOptionsSchema) +- [PriorityItemSchema](./variables/PriorityItemSchema) +- [PriorityQueueOptionsSchema](./variables/PriorityQueueOptionsSchema) +- [RabinKarpMultiSearchSchema](./variables/RabinKarpMultiSearchSchema) +- [RabinKarpOptionsSchema](./variables/RabinKarpOptionsSchema) +- [RabinKarpSearchSchema](./variables/RabinKarpSearchSchema) +- [TrieInsertSchema](./variables/TrieInsertSchema) +- [TrieOptionsSchema](./variables/TrieOptionsSchema) +- [TrieSearchSchema](./variables/TrieSearchSchema) +- [VertexIdSchema](./variables/VertexIdSchema) ## Functions -- [createValidator](./functions/createValidator.md) -- [validate](./functions/validate.md) -- [validateSafe](./functions/validateSafe.md) +- [createValidator](./functions/createValidator) +- [validate](./functions/validate) +- [validateSafe](./functions/validateSafe) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/GraphEdge.md b/sdks/typescript/api/dsa/schemas/type-aliases/GraphEdge.md index 34fc1a4f..6e14913c 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/GraphEdge.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/GraphEdge.md @@ -1,5 +1,5 @@ # Type Alias: GraphEdge -> **GraphEdge** = `S.Schema.Type`\<*typeof* [`GraphEdgeSchema`](../variables/GraphEdgeSchema.md)\> +> **GraphEdge** = `S.Schema.Type`\<*typeof* [`GraphEdgeSchema`](../variables/GraphEdgeSchema)\> Defined in: [schemas.ts:103](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L103) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/GraphOptions.md b/sdks/typescript/api/dsa/schemas/type-aliases/GraphOptions.md index 06a7d41a..5b2280d7 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/GraphOptions.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/GraphOptions.md @@ -1,5 +1,5 @@ # Type Alias: GraphOptions -> **GraphOptions** = `S.Schema.Type`\<*typeof* [`GraphOptionsSchema`](../variables/GraphOptionsSchema.md)\> +> **GraphOptions** = `S.Schema.Type`\<*typeof* [`GraphOptionsSchema`](../variables/GraphOptionsSchema)\> Defined in: [schemas.ts:96](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L96) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/PriorityItemInput.md b/sdks/typescript/api/dsa/schemas/type-aliases/PriorityItemInput.md index f3224685..6a2a3119 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/PriorityItemInput.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/PriorityItemInput.md @@ -1,5 +1,5 @@ # Type Alias: PriorityItemInput -> **PriorityItemInput** = `S.Schema.Type`\<*typeof* [`PriorityItemSchema`](../variables/PriorityItemSchema.md)\> +> **PriorityItemInput** = `S.Schema.Type`\<*typeof* [`PriorityItemSchema`](../variables/PriorityItemSchema)\> Defined in: [schemas.ts:64](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L64) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/PriorityQueueOptions.md b/sdks/typescript/api/dsa/schemas/type-aliases/PriorityQueueOptions.md index 96a817f7..c3283613 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/PriorityQueueOptions.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/PriorityQueueOptions.md @@ -1,5 +1,5 @@ # Type Alias: PriorityQueueOptions -> **PriorityQueueOptions** = `S.Schema.Type`\<*typeof* [`PriorityQueueOptionsSchema`](../variables/PriorityQueueOptionsSchema.md)\> +> **PriorityQueueOptions** = `S.Schema.Type`\<*typeof* [`PriorityQueueOptionsSchema`](../variables/PriorityQueueOptionsSchema)\> Defined in: [schemas.ts:55](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L55) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpMultiSearch.md b/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpMultiSearch.md index be2a6e7f..ff4a3e2b 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpMultiSearch.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpMultiSearch.md @@ -1,5 +1,5 @@ # Type Alias: RabinKarpMultiSearch -> **RabinKarpMultiSearch** = `S.Schema.Type`\<*typeof* [`RabinKarpMultiSearchSchema`](../variables/RabinKarpMultiSearchSchema.md)\> +> **RabinKarpMultiSearch** = `S.Schema.Type`\<*typeof* [`RabinKarpMultiSearchSchema`](../variables/RabinKarpMultiSearchSchema)\> Defined in: [schemas.ts:87](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L87) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpOptions.md b/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpOptions.md index 30d4c09e..591dae3e 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpOptions.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpOptions.md @@ -1,5 +1,5 @@ # Type Alias: RabinKarpOptions -> **RabinKarpOptions** = `S.Schema.Type`\<*typeof* [`RabinKarpOptionsSchema`](../variables/RabinKarpOptionsSchema.md)\> +> **RabinKarpOptions** = `S.Schema.Type`\<*typeof* [`RabinKarpOptionsSchema`](../variables/RabinKarpOptionsSchema)\> Defined in: [schemas.ts:75](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L75) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpSearch.md b/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpSearch.md index 7580b13a..df78f931 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpSearch.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/RabinKarpSearch.md @@ -1,5 +1,5 @@ # Type Alias: RabinKarpSearch -> **RabinKarpSearch** = `S.Schema.Type`\<*typeof* [`RabinKarpSearchSchema`](../variables/RabinKarpSearchSchema.md)\> +> **RabinKarpSearch** = `S.Schema.Type`\<*typeof* [`RabinKarpSearchSchema`](../variables/RabinKarpSearchSchema)\> Defined in: [schemas.ts:81](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L81) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/TrieInsert.md b/sdks/typescript/api/dsa/schemas/type-aliases/TrieInsert.md index 8b8cae94..74039e1d 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/TrieInsert.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/TrieInsert.md @@ -1,5 +1,5 @@ # Type Alias: TrieInsert -> **TrieInsert** = `S.Schema.Type`\<*typeof* [`TrieInsertSchema`](../variables/TrieInsertSchema.md)\> +> **TrieInsert** = `S.Schema.Type`\<*typeof* [`TrieInsertSchema`](../variables/TrieInsertSchema)\> Defined in: [schemas.ts:40](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L40) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/TrieOptions.md b/sdks/typescript/api/dsa/schemas/type-aliases/TrieOptions.md index d85c6444..2b5bd63d 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/TrieOptions.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/TrieOptions.md @@ -1,5 +1,5 @@ # Type Alias: TrieOptions -> **TrieOptions** = `S.Schema.Type`\<*typeof* [`TrieOptionsSchema`](../variables/TrieOptionsSchema.md)\> +> **TrieOptions** = `S.Schema.Type`\<*typeof* [`TrieOptionsSchema`](../variables/TrieOptionsSchema)\> Defined in: [schemas.ts:35](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L35) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/TrieSearch.md b/sdks/typescript/api/dsa/schemas/type-aliases/TrieSearch.md index 4b1730d2..69e33120 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/TrieSearch.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/TrieSearch.md @@ -1,5 +1,5 @@ # Type Alias: TrieSearch -> **TrieSearch** = `S.Schema.Type`\<*typeof* [`TrieSearchSchema`](../variables/TrieSearchSchema.md)\> +> **TrieSearch** = `S.Schema.Type`\<*typeof* [`TrieSearchSchema`](../variables/TrieSearchSchema)\> Defined in: [schemas.ts:46](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L46) diff --git a/sdks/typescript/api/dsa/schemas/type-aliases/VertexId.md b/sdks/typescript/api/dsa/schemas/type-aliases/VertexId.md index d5aaa702..3baa16d3 100644 --- a/sdks/typescript/api/dsa/schemas/type-aliases/VertexId.md +++ b/sdks/typescript/api/dsa/schemas/type-aliases/VertexId.md @@ -1,5 +1,5 @@ # Type Alias: VertexId -> **VertexId** = `S.Schema.Type`\<*typeof* [`VertexIdSchema`](../variables/VertexIdSchema.md)\> +> **VertexId** = `S.Schema.Type`\<*typeof* [`VertexIdSchema`](../variables/VertexIdSchema)\> Defined in: [schemas.ts:106](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/schemas.ts#L106) diff --git a/sdks/typescript/api/dsa/trie/classes/Trie.md b/sdks/typescript/api/dsa/trie/classes/Trie.md index 986a4f53..e89cf60d 100644 --- a/sdks/typescript/api/dsa/trie/classes/Trie.md +++ b/sdks/typescript/api/dsa/trie/classes/Trie.md @@ -220,7 +220,7 @@ The associated data or null if not found ### searchByPrefix() -> **searchByPrefix**(`prefix`, `limit?`): [`TrieSearchResult`](../interfaces/TrieSearchResult.md)\<`T`\>[] +> **searchByPrefix**(`prefix`, `limit?`): [`TrieSearchResult`](../interfaces/TrieSearchResult)\<`T`\>[] Defined in: [trie.ts:194](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/dsa/src/trie.ts#L194) @@ -242,7 +242,7 @@ Maximum number of results (defaults to maxResults option) #### Returns -[`TrieSearchResult`](../interfaces/TrieSearchResult.md)\<`T`\>[] +[`TrieSearchResult`](../interfaces/TrieSearchResult)\<`T`\>[] Array of search results sorted by relevance diff --git a/sdks/typescript/api/dsa/trie/index.md b/sdks/typescript/api/dsa/trie/index.md index 0f905314..179830d7 100644 --- a/sdks/typescript/api/dsa/trie/index.md +++ b/sdks/typescript/api/dsa/trie/index.md @@ -2,18 +2,18 @@ ## Classes -- [Trie](./classes/Trie.md) +- [Trie](./classes/Trie) ## Interfaces -- [TrieSearchResult](./interfaces/TrieSearchResult.md) +- [TrieSearchResult](./interfaces/TrieSearchResult) ## Functions -- [rabinKarp](./functions/rabinKarp.md) +- [rabinKarp](./functions/rabinKarp) ## References ### TrieOptions -Re-exports [TrieOptions](../schemas/type-aliases/TrieOptions.md) +Re-exports [TrieOptions](../schemas/type-aliases/TrieOptions) diff --git a/sdks/typescript/api/http/fetcher/functions/del.md b/sdks/typescript/api/http/fetcher/functions/del.md index cd21a272..2652a1dc 100644 --- a/sdks/typescript/api/http/fetcher/functions/del.md +++ b/sdks/typescript/api/http/fetcher/functions/del.md @@ -2,7 +2,7 @@ ## Call Signature -> **del**\<`T`\>(`url`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **del**\<`T`\>(`url`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:611](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L611) @@ -20,17 +20,17 @@ Defined in: [packages/http/src/fetcher.ts:611](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **del**\<`S`\>(`url`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **del**\<`S`\>(`url`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:617](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L617) @@ -48,10 +48,10 @@ Defined in: [packages/http/src/fetcher.ts:617](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`Type`\<`S`\>\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`Type`\<`S`\>\> & `object` #### params? ### Returns -`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> diff --git a/sdks/typescript/api/http/fetcher/functions/fetcher.md b/sdks/typescript/api/http/fetcher/functions/fetcher.md index 81f36449..6761a8a1 100644 --- a/sdks/typescript/api/http/fetcher/functions/fetcher.md +++ b/sdks/typescript/api/http/fetcher/functions/fetcher.md @@ -2,7 +2,7 @@ ## Call Signature -> **fetcher**\<`T`\>(`input`, `method?`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **fetcher**\<`T`\>(`input`, `method?`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:366](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L366) @@ -24,17 +24,17 @@ Defined in: [packages/http/src/fetcher.ts:366](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **fetcher**\<`S`\>(`input`, `method`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **fetcher**\<`S`\>(`input`, `method`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:373](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L373) @@ -56,17 +56,17 @@ Defined in: [packages/http/src/fetcher.ts:373](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`Type`\<`S`\>\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`Type`\<`S`\>\> & `object` #### params? ### Returns -`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **fetcher**\<`T`\>(`input`, `method`, `options?`, `params?`, `body?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **fetcher**\<`T`\>(`input`, `method`, `options?`, `params?`, `body?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:384](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L384) @@ -88,7 +88,7 @@ Defined in: [packages/http/src/fetcher.ts:384](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? @@ -98,11 +98,11 @@ Defined in: [packages/http/src/fetcher.ts:384](https://github.com/resq-software/ ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **fetcher**\<`S`\>(`input`, `method`, `options`, `params?`, `body?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **fetcher**\<`S`\>(`input`, `method`, `options`, `params?`, `body?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:392](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L392) @@ -124,7 +124,7 @@ Defined in: [packages/http/src/fetcher.ts:392](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`Type`\<`S`\>\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`Type`\<`S`\>\> & `object` #### params? @@ -134,11 +134,11 @@ Defined in: [packages/http/src/fetcher.ts:392](https://github.com/resq-software/ ### Returns -`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **fetcher**\<`T`\>(`input`, `method`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **fetcher**\<`T`\>(`input`, `method`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:404](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L404) @@ -160,10 +160,10 @@ Defined in: [packages/http/src/fetcher.ts:404](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> diff --git a/sdks/typescript/api/http/fetcher/functions/get.md b/sdks/typescript/api/http/fetcher/functions/get.md index 3037e3b3..d5462b02 100644 --- a/sdks/typescript/api/http/fetcher/functions/get.md +++ b/sdks/typescript/api/http/fetcher/functions/get.md @@ -2,7 +2,7 @@ ## Call Signature -> **get**\<`T`\>(`url`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **get**\<`T`\>(`url`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:514](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L514) @@ -20,17 +20,17 @@ Defined in: [packages/http/src/fetcher.ts:514](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **get**\<`A`\>(`url`, `options`, `params?`): `Effect`\<`A`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **get**\<`A`\>(`url`, `options`, `params?`): `Effect`\<`A`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:520](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L520) @@ -48,10 +48,10 @@ Defined in: [packages/http/src/fetcher.ts:520](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`A`\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`A`\> & `object` #### params? ### Returns -`Effect`\<`A`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`A`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> diff --git a/sdks/typescript/api/http/fetcher/functions/head.md b/sdks/typescript/api/http/fetcher/functions/head.md index b4a5a75f..291b3acf 100644 --- a/sdks/typescript/api/http/fetcher/functions/head.md +++ b/sdks/typescript/api/http/fetcher/functions/head.md @@ -2,7 +2,7 @@ ## Call Signature -> **head**\<`T`\>(`url`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **head**\<`T`\>(`url`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:655](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L655) @@ -20,17 +20,17 @@ Defined in: [packages/http/src/fetcher.ts:655](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **head**\<`S`\>(`url`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **head**\<`S`\>(`url`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:661](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L661) @@ -48,10 +48,10 @@ Defined in: [packages/http/src/fetcher.ts:661](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`Type`\<`S`\>\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`Type`\<`S`\>\> & `object` #### params? ### Returns -`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> diff --git a/sdks/typescript/api/http/fetcher/functions/options.md b/sdks/typescript/api/http/fetcher/functions/options.md index 3f29b445..0cf5522d 100644 --- a/sdks/typescript/api/http/fetcher/functions/options.md +++ b/sdks/typescript/api/http/fetcher/functions/options.md @@ -2,7 +2,7 @@ ## Call Signature -> **options**\<`T`\>(`url`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **options**\<`T`\>(`url`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:631](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L631) @@ -20,17 +20,17 @@ Defined in: [packages/http/src/fetcher.ts:631](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **options**\<`S`\>(`url`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **options**\<`S`\>(`url`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:637](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L637) @@ -48,10 +48,10 @@ Defined in: [packages/http/src/fetcher.ts:637](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`Type`\<`S`\>\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`Type`\<`S`\>\> & `object` #### params? ### Returns -`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> diff --git a/sdks/typescript/api/http/fetcher/functions/patch.md b/sdks/typescript/api/http/fetcher/functions/patch.md index 5aa87eac..0cdd4d9f 100644 --- a/sdks/typescript/api/http/fetcher/functions/patch.md +++ b/sdks/typescript/api/http/fetcher/functions/patch.md @@ -2,7 +2,7 @@ ## Call Signature -> **patch**\<`T`\>(`url`, `body?`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **patch**\<`T`\>(`url`, `body?`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:584](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L584) @@ -24,17 +24,17 @@ Defined in: [packages/http/src/fetcher.ts:584](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **patch**\<`S`\>(`url`, `body`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **patch**\<`S`\>(`url`, `body`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:591](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L591) @@ -56,10 +56,10 @@ Defined in: [packages/http/src/fetcher.ts:591](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`Type`\<`S`\>\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`Type`\<`S`\>\> & `object` #### params? ### Returns -`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> diff --git a/sdks/typescript/api/http/fetcher/functions/post.md b/sdks/typescript/api/http/fetcher/functions/post.md index 75f30c28..8667ba28 100644 --- a/sdks/typescript/api/http/fetcher/functions/post.md +++ b/sdks/typescript/api/http/fetcher/functions/post.md @@ -2,7 +2,7 @@ ## Call Signature -> **post**\<`T`\>(`url`, `body?`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **post**\<`T`\>(`url`, `body?`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:530](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L530) @@ -24,17 +24,17 @@ Defined in: [packages/http/src/fetcher.ts:530](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **post**\<`S`\>(`url`, `body`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **post**\<`S`\>(`url`, `body`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:537](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L537) @@ -56,10 +56,10 @@ Defined in: [packages/http/src/fetcher.ts:537](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`Type`\<`S`\>\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`Type`\<`S`\>\> & `object` #### params? ### Returns -`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> diff --git a/sdks/typescript/api/http/fetcher/functions/put.md b/sdks/typescript/api/http/fetcher/functions/put.md index 8d8505c2..a32ccee6 100644 --- a/sdks/typescript/api/http/fetcher/functions/put.md +++ b/sdks/typescript/api/http/fetcher/functions/put.md @@ -2,7 +2,7 @@ ## Call Signature -> **put**\<`T`\>(`url`, `body?`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **put**\<`T`\>(`url`, `body?`, `options?`, `params?`): `Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:557](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L557) @@ -24,17 +24,17 @@ Defined in: [packages/http/src/fetcher.ts:557](https://github.com/resq-software/ #### options? -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`T`\> +[`FetcherOptions`](../interfaces/FetcherOptions)\<`T`\> #### params? ### Returns -`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`T`, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> ## Call Signature -> **put**\<`S`\>(`url`, `body`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +> **put**\<`S`\>(`url`, `body`, `options`, `params?`): `Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> Defined in: [packages/http/src/fetcher.ts:564](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/http/src/fetcher.ts#L564) @@ -56,10 +56,10 @@ Defined in: [packages/http/src/fetcher.ts:564](https://github.com/resq-software/ #### options -[`FetcherOptions`](../interfaces/FetcherOptions.md)\<`Type`\<`S`\>\> & `object` +[`FetcherOptions`](../interfaces/FetcherOptions)\<`Type`\<`S`\>\> & `object` #### params? ### Returns -`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError.md) \| [`FetcherError`](../classes/FetcherError.md), `HttpClient`\> +`Effect`\<`Type`\<`S`\>, [`FetcherValidationError`](../classes/FetcherValidationError) \| [`FetcherError`](../classes/FetcherError), `HttpClient`\> diff --git a/sdks/typescript/api/http/fetcher/index.md b/sdks/typescript/api/http/fetcher/index.md index 7164f288..89e86f92 100644 --- a/sdks/typescript/api/http/fetcher/index.md +++ b/sdks/typescript/api/http/fetcher/index.md @@ -2,29 +2,29 @@ ## Classes -- [FetcherError](./classes/FetcherError.md) -- [FetcherValidationError](./classes/FetcherValidationError.md) +- [FetcherError](./classes/FetcherError) +- [FetcherValidationError](./classes/FetcherValidationError) ## Interfaces -- [FetcherOptions](./interfaces/FetcherOptions.md) +- [FetcherOptions](./interfaces/FetcherOptions) ## Type Aliases -- [Headers](./type-aliases/Headers.md) -- [HttpMethod](./type-aliases/HttpMethod.md) -- [QueryParams](./type-aliases/QueryParams.md) -- [RequestBody](./type-aliases/RequestBody.md) +- [Headers](./type-aliases/Headers) +- [HttpMethod](./type-aliases/HttpMethod) +- [QueryParams](./type-aliases/QueryParams) +- [RequestBody](./type-aliases/RequestBody) ## Functions -- [createApiResponseSchema](./functions/createApiResponseSchema.md) -- [createPaginatedSchema](./functions/createPaginatedSchema.md) -- [del](./functions/del.md) -- [fetcher](./functions/fetcher.md) -- [get](./functions/get.md) -- [head](./functions/head.md) -- [options](./functions/options.md) -- [patch](./functions/patch.md) -- [post](./functions/post.md) -- [put](./functions/put.md) +- [createApiResponseSchema](./functions/createApiResponseSchema) +- [createPaginatedSchema](./functions/createPaginatedSchema) +- [del](./functions/del) +- [fetcher](./functions/fetcher) +- [get](./functions/get) +- [head](./functions/head) +- [options](./functions/options) +- [patch](./functions/patch) +- [post](./functions/post) +- [put](./functions/put) diff --git a/sdks/typescript/api/http/index.md b/sdks/typescript/api/http/index.md index 67cca6f6..cbee6f7b 100644 --- a/sdks/typescript/api/http/index.md +++ b/sdks/typescript/api/http/index.md @@ -2,6 +2,6 @@ ## Modules -- [fetcher](./fetcher/index.md) -- [index](./index/index.md) -- [security](./security/index.md) +- [fetcher](./fetcher) +- [index](./index) +- [security](./security) diff --git a/sdks/typescript/api/http/index/index.md b/sdks/typescript/api/http/index/index.md index 53792f04..d3784cb9 100644 --- a/sdks/typescript/api/http/index/index.md +++ b/sdks/typescript/api/http/index/index.md @@ -4,112 +4,112 @@ ### createApiResponseSchema -Re-exports [createApiResponseSchema](../fetcher/functions/createApiResponseSchema.md) +Re-exports [createApiResponseSchema](../fetcher/functions/createApiResponseSchema) *** ### createPaginatedSchema -Re-exports [createPaginatedSchema](../fetcher/functions/createPaginatedSchema.md) +Re-exports [createPaginatedSchema](../fetcher/functions/createPaginatedSchema) *** ### del -Re-exports [del](../fetcher/functions/del.md) +Re-exports [del](../fetcher/functions/del) *** ### fetcher -Re-exports [fetcher](../fetcher/functions/fetcher.md) +Re-exports [fetcher](../fetcher/functions/fetcher) *** ### FetcherError -Re-exports [FetcherError](../fetcher/classes/FetcherError.md) +Re-exports [FetcherError](../fetcher/classes/FetcherError) *** ### FetcherOptions -Re-exports [FetcherOptions](../fetcher/interfaces/FetcherOptions.md) +Re-exports [FetcherOptions](../fetcher/interfaces/FetcherOptions) *** ### FetcherValidationError -Re-exports [FetcherValidationError](../fetcher/classes/FetcherValidationError.md) +Re-exports [FetcherValidationError](../fetcher/classes/FetcherValidationError) *** ### get -Re-exports [get](../fetcher/functions/get.md) +Re-exports [get](../fetcher/functions/get) *** ### getRequestId -Re-exports [getRequestId](../security/functions/getRequestId.md) +Re-exports [getRequestId](../security/functions/getRequestId) *** ### head -Re-exports [head](../fetcher/functions/head.md) +Re-exports [head](../fetcher/functions/head) *** ### Headers -Re-exports [Headers](../fetcher/type-aliases/Headers.md) +Re-exports [Headers](../fetcher/type-aliases/Headers) *** ### HttpMethod -Re-exports [HttpMethod](../fetcher/type-aliases/HttpMethod.md) +Re-exports [HttpMethod](../fetcher/type-aliases/HttpMethod) *** ### options -Re-exports [options](../fetcher/functions/options.md) +Re-exports [options](../fetcher/functions/options) *** ### patch -Re-exports [patch](../fetcher/functions/patch.md) +Re-exports [patch](../fetcher/functions/patch) *** ### post -Re-exports [post](../fetcher/functions/post.md) +Re-exports [post](../fetcher/functions/post) *** ### put -Re-exports [put](../fetcher/functions/put.md) +Re-exports [put](../fetcher/functions/put) *** ### QueryParams -Re-exports [QueryParams](../fetcher/type-aliases/QueryParams.md) +Re-exports [QueryParams](../fetcher/type-aliases/QueryParams) *** ### RequestBody -Re-exports [RequestBody](../fetcher/type-aliases/RequestBody.md) +Re-exports [RequestBody](../fetcher/type-aliases/RequestBody) *** ### shouldRedirectToHttps -Re-exports [shouldRedirectToHttps](../security/functions/shouldRedirectToHttps.md) +Re-exports [shouldRedirectToHttps](../security/functions/shouldRedirectToHttps) diff --git a/sdks/typescript/api/http/security/index.md b/sdks/typescript/api/http/security/index.md index ac24d81e..0c3507f7 100644 --- a/sdks/typescript/api/http/security/index.md +++ b/sdks/typescript/api/http/security/index.md @@ -2,5 +2,5 @@ ## Functions -- [getRequestId](./functions/getRequestId.md) -- [shouldRedirectToHttps](./functions/shouldRedirectToHttps.md) +- [getRequestId](./functions/getRequestId) +- [shouldRedirectToHttps](./functions/shouldRedirectToHttps) diff --git a/sdks/typescript/api/logger/index.md b/sdks/typescript/api/logger/index.md index 7c7fcbe1..6cc5d10d 100644 --- a/sdks/typescript/api/logger/index.md +++ b/sdks/typescript/api/logger/index.md @@ -2,7 +2,7 @@ ## Modules -- [index](./index/index.md) -- [logger](./logger/index.md) -- [logger.decorators](./logger.decorators/index.md) -- [logger.types](./logger.types/index.md) +- [index](./index) +- [logger](./logger) +- [logger.decorators](./logger.decorators) +- [logger.types](./logger.types) diff --git a/sdks/typescript/api/logger/index/index.md b/sdks/typescript/api/logger/index/index.md index 90ae7e31..251528e8 100644 --- a/sdks/typescript/api/logger/index/index.md +++ b/sdks/typescript/api/logger/index/index.md @@ -4,100 +4,100 @@ ### ColorKey -Re-exports [ColorKey](../logger/type-aliases/ColorKey.md) +Re-exports [ColorKey](../logger/type-aliases/ColorKey) *** ### Log -Re-exports [Log](../logger.decorators/functions/Log.md) +Re-exports [Log](../logger.decorators/functions/Log) *** ### LogClass -Re-exports [LogClass](../logger.decorators/functions/LogClass.md) +Re-exports [LogClass](../logger.decorators/functions/LogClass) *** ### LogClassOptions -Re-exports [LogClassOptions](../logger.types/interfaces/LogClassOptions.md) +Re-exports [LogClassOptions](../logger.types/interfaces/LogClassOptions) *** ### LogData -Re-exports [LogData](../logger/interfaces/LogData.md) +Re-exports [LogData](../logger/interfaces/LogData) *** ### LogEntry -Re-exports [LogEntry](../logger.types/interfaces/LogEntry.md) +Re-exports [LogEntry](../logger.types/interfaces/LogEntry) *** ### LogError -Re-exports [LogError](../logger.decorators/functions/LogError.md) +Re-exports [LogError](../logger.decorators/functions/LogError) *** ### LogErrorOptions -Re-exports [LogErrorOptions](../logger.types/interfaces/LogErrorOptions.md) +Re-exports [LogErrorOptions](../logger.types/interfaces/LogErrorOptions) *** ### logger -Re-exports [logger](../logger/variables/logger.md) +Re-exports [logger](../logger/variables/logger) *** ### Logger -Re-exports [Logger](../logger/classes/Logger.md) +Re-exports [Logger](../logger/classes/Logger) *** ### LoggerOptions -Re-exports [LoggerOptions](../logger/interfaces/LoggerOptions.md) +Re-exports [LoggerOptions](../logger/interfaces/LoggerOptions) *** ### LogLevel -Re-exports [LogLevel](../logger/enumerations/LogLevel.md) +Re-exports [LogLevel](../logger/enumerations/LogLevel) *** ### LogLevelString -Re-exports [LogLevelString](../logger.types/type-aliases/LogLevelString.md) +Re-exports [LogLevelString](../logger.types/type-aliases/LogLevelString) *** ### LogMethodOptions -Re-exports [LogMethodOptions](../logger.types/interfaces/LogMethodOptions.md) +Re-exports [LogMethodOptions](../logger.types/interfaces/LogMethodOptions) *** ### LogTiming -Re-exports [LogTiming](../logger.decorators/functions/LogTiming.md) +Re-exports [LogTiming](../logger.decorators/functions/LogTiming) *** ### LogTimingOptions -Re-exports [LogTimingOptions](../logger.types/interfaces/LogTimingOptions.md) +Re-exports [LogTimingOptions](../logger.types/interfaces/LogTimingOptions) *** ### LogTransport -Re-exports [LogTransport](../logger.types/interfaces/LogTransport.md) +Re-exports [LogTransport](../logger.types/interfaces/LogTransport) diff --git a/sdks/typescript/api/logger/logger.decorators/functions/Log.md b/sdks/typescript/api/logger/logger.decorators/functions/Log.md index f59ab295..5bb7f7a9 100644 --- a/sdks/typescript/api/logger/logger.decorators/functions/Log.md +++ b/sdks/typescript/api/logger/logger.decorators/functions/Log.md @@ -11,7 +11,7 @@ Can optionally log arguments and return values. ### options? -[`LogMethodOptions`](../../logger.types/interfaces/LogMethodOptions.md) = `{}` +[`LogMethodOptions`](../../logger.types/interfaces/LogMethodOptions) = `{}` Configuration options diff --git a/sdks/typescript/api/logger/logger.decorators/functions/LogClass.md b/sdks/typescript/api/logger/logger.decorators/functions/LogClass.md index 537dcb81..f43dc49e 100644 --- a/sdks/typescript/api/logger/logger.decorators/functions/LogClass.md +++ b/sdks/typescript/api/logger/logger.decorators/functions/LogClass.md @@ -11,7 +11,7 @@ Can be configured to exclude specific methods. ### options? -[`LogClassOptions`](../../logger.types/interfaces/LogClassOptions.md) = `{}` +[`LogClassOptions`](../../logger.types/interfaces/LogClassOptions) = `{}` Configuration options diff --git a/sdks/typescript/api/logger/logger.decorators/functions/LogError.md b/sdks/typescript/api/logger/logger.decorators/functions/LogError.md index 9ff65e53..b5b4ec14 100644 --- a/sdks/typescript/api/logger/logger.decorators/functions/LogError.md +++ b/sdks/typescript/api/logger/logger.decorators/functions/LogError.md @@ -11,7 +11,7 @@ Can optionally suppress the error or rethrow it. ### options? -[`LogErrorOptions`](../../logger.types/interfaces/LogErrorOptions.md) = `{}` +[`LogErrorOptions`](../../logger.types/interfaces/LogErrorOptions) = `{}` Configuration options diff --git a/sdks/typescript/api/logger/logger.decorators/functions/LogTiming.md b/sdks/typescript/api/logger/logger.decorators/functions/LogTiming.md index 62f24e81..a5d51c0e 100644 --- a/sdks/typescript/api/logger/logger.decorators/functions/LogTiming.md +++ b/sdks/typescript/api/logger/logger.decorators/functions/LogTiming.md @@ -11,7 +11,7 @@ Useful for performance monitoring. ### options? -[`LogTimingOptions`](../../logger.types/interfaces/LogTimingOptions.md) = `{}` +[`LogTimingOptions`](../../logger.types/interfaces/LogTimingOptions) = `{}` Configuration options diff --git a/sdks/typescript/api/logger/logger.decorators/index.md b/sdks/typescript/api/logger/logger.decorators/index.md index 70b1a789..5c52ef49 100644 --- a/sdks/typescript/api/logger/logger.decorators/index.md +++ b/sdks/typescript/api/logger/logger.decorators/index.md @@ -2,7 +2,7 @@ ## Functions -- [Log](./functions/Log.md) -- [LogClass](./functions/LogClass.md) -- [LogError](./functions/LogError.md) -- [LogTiming](./functions/LogTiming.md) +- [Log](./functions/Log) +- [LogClass](./functions/LogClass) +- [LogError](./functions/LogError) +- [LogTiming](./functions/LogTiming) diff --git a/sdks/typescript/api/logger/logger.types/index.md b/sdks/typescript/api/logger/logger.types/index.md index b070eb32..5e37c462 100644 --- a/sdks/typescript/api/logger/logger.types/index.md +++ b/sdks/typescript/api/logger/logger.types/index.md @@ -2,16 +2,16 @@ ## Interfaces -- [LogClassOptions](./interfaces/LogClassOptions.md) -- [LogData](./interfaces/LogData.md) -- [LogEntry](./interfaces/LogEntry.md) -- [LogErrorOptions](./interfaces/LogErrorOptions.md) -- [LoggerOptions](./interfaces/LoggerOptions.md) -- [LogMethodOptions](./interfaces/LogMethodOptions.md) -- [LogTimingOptions](./interfaces/LogTimingOptions.md) -- [LogTransport](./interfaces/LogTransport.md) +- [LogClassOptions](./interfaces/LogClassOptions) +- [LogData](./interfaces/LogData) +- [LogEntry](./interfaces/LogEntry) +- [LogErrorOptions](./interfaces/LogErrorOptions) +- [LoggerOptions](./interfaces/LoggerOptions) +- [LogMethodOptions](./interfaces/LogMethodOptions) +- [LogTimingOptions](./interfaces/LogTimingOptions) +- [LogTransport](./interfaces/LogTransport) ## Type Aliases -- [ColorKey](./type-aliases/ColorKey.md) -- [LogLevelString](./type-aliases/LogLevelString.md) +- [ColorKey](./type-aliases/ColorKey) +- [LogLevelString](./type-aliases/LogLevelString) diff --git a/sdks/typescript/api/logger/logger.types/interfaces/LogEntry.md b/sdks/typescript/api/logger/logger.types/interfaces/LogEntry.md index 41df3313..8b122c87 100644 --- a/sdks/typescript/api/logger/logger.types/interfaces/LogEntry.md +++ b/sdks/typescript/api/logger/logger.types/interfaces/LogEntry.md @@ -18,7 +18,7 @@ Logger context/category ### data? -> `optional` **data?**: [`LogData`](./LogData.md) +> `optional` **data?**: [`LogData`](./LogData) Defined in: [logger.types.ts:90](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/logger/src/logger.types.ts#L90) @@ -38,7 +38,7 @@ Environment (client/server) ### level -> **level**: [`LogLevelString`](../type-aliases/LogLevelString.md) +> **level**: [`LogLevelString`](../type-aliases/LogLevelString) Defined in: [logger.types.ts:84](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/logger/src/logger.types.ts#L84) diff --git a/sdks/typescript/api/logger/logger.types/interfaces/LogMethodOptions.md b/sdks/typescript/api/logger/logger.types/interfaces/LogMethodOptions.md index 66b2edbe..73f67cb8 100644 --- a/sdks/typescript/api/logger/logger.types/interfaces/LogMethodOptions.md +++ b/sdks/typescript/api/logger/logger.types/interfaces/LogMethodOptions.md @@ -12,7 +12,7 @@ decorator ### level? -> `optional` **level?**: [`LogLevelString`](../type-aliases/LogLevelString.md) +> `optional` **level?**: [`LogLevelString`](../type-aliases/LogLevelString) Defined in: [logger.types.ts:118](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/logger/src/logger.types.ts#L118) diff --git a/sdks/typescript/api/logger/logger.types/interfaces/LogTimingOptions.md b/sdks/typescript/api/logger/logger.types/interfaces/LogTimingOptions.md index 7c360046..d20668b8 100644 --- a/sdks/typescript/api/logger/logger.types/interfaces/LogTimingOptions.md +++ b/sdks/typescript/api/logger/logger.types/interfaces/LogTimingOptions.md @@ -22,7 +22,7 @@ Custom label for timing logs ### level? -> `optional` **level?**: [`LogLevelString`](../type-aliases/LogLevelString.md) +> `optional` **level?**: [`LogLevelString`](../type-aliases/LogLevelString) Defined in: [logger.types.ts:131](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/logger/src/logger.types.ts#L131) diff --git a/sdks/typescript/api/logger/logger.types/interfaces/LogTransport.md b/sdks/typescript/api/logger/logger.types/interfaces/LogTransport.md index 3cf78008..6d1d6528 100644 --- a/sdks/typescript/api/logger/logger.types/interfaces/LogTransport.md +++ b/sdks/typescript/api/logger/logger.types/interfaces/LogTransport.md @@ -28,7 +28,7 @@ Method to write a log entry ##### entry -[`LogEntry`](./LogEntry.md) +[`LogEntry`](./LogEntry) #### Returns diff --git a/sdks/typescript/api/logger/logger.types/interfaces/LoggerOptions.md b/sdks/typescript/api/logger/logger.types/interfaces/LoggerOptions.md index ea04d704..2aa0cc9a 100644 --- a/sdks/typescript/api/logger/logger.types/interfaces/LoggerOptions.md +++ b/sdks/typescript/api/logger/logger.types/interfaces/LoggerOptions.md @@ -48,7 +48,7 @@ Whether to write logs to a file (server-side only) ### minLevel? -> `optional` **minLevel?**: [`LogLevel`](../../logger/enumerations/LogLevel.md) +> `optional` **minLevel?**: [`LogLevel`](../../logger/enumerations/LogLevel) Defined in: [logger.types.ts:36](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/logger/src/logger.types.ts#L36) diff --git a/sdks/typescript/api/logger/logger/classes/Logger.md b/sdks/typescript/api/logger/logger/classes/Logger.md index 9ff2860a..685fce7b 100644 --- a/sdks/typescript/api/logger/logger/classes/Logger.md +++ b/sdks/typescript/api/logger/logger/classes/Logger.md @@ -25,7 +25,7 @@ The context name for this logger (e.g., component or service name) ##### options? -[`LoggerOptions`](../interfaces/LoggerOptions.md) = `{}` +[`LoggerOptions`](../interfaces/LoggerOptions) = `{}` Optional logger configuration @@ -53,7 +53,7 @@ The action message ##### data? -[`LogData`](../interfaces/LogData.md) +[`LogData`](../interfaces/LogData) Optional data to include @@ -81,7 +81,7 @@ The debug message ##### data? -[`LogData`](../interfaces/LogData.md) +[`LogData`](../interfaces/LogData) Optional data to include @@ -115,7 +115,7 @@ Optional Error object or unknown error ##### data? -[`LogData`](../interfaces/LogData.md) +[`LogData`](../interfaces/LogData) Optional additional data @@ -179,7 +179,7 @@ The message to log ##### data? -[`LogData`](../interfaces/LogData.md) +[`LogData`](../interfaces/LogData) Optional data to include @@ -207,7 +207,7 @@ The success message ##### data? -[`LogData`](../interfaces/LogData.md) +[`LogData`](../interfaces/LogData) Optional data to include @@ -273,7 +273,7 @@ The trace message ##### data? -[`LogData`](../interfaces/LogData.md) +[`LogData`](../interfaces/LogData) Optional data to include @@ -301,7 +301,7 @@ The warning message ##### data? -[`LogData`](../interfaces/LogData.md) +[`LogData`](../interfaces/LogData) Optional data to include @@ -330,7 +330,7 @@ The context name ##### options? -[`LoggerOptions`](../interfaces/LoggerOptions.md) +[`LoggerOptions`](../interfaces/LoggerOptions) Optional logger configuration @@ -354,7 +354,7 @@ Set global minimum log level for all logger instances ##### level -[`LogLevel`](../enumerations/LogLevel.md) +[`LogLevel`](../enumerations/LogLevel) The minimum level to log across all loggers diff --git a/sdks/typescript/api/logger/logger/index.md b/sdks/typescript/api/logger/logger/index.md index 5b7156a7..44faaa54 100644 --- a/sdks/typescript/api/logger/logger/index.md +++ b/sdks/typescript/api/logger/logger/index.md @@ -2,21 +2,21 @@ ## Enumerations -- [LogLevel](./enumerations/LogLevel.md) +- [LogLevel](./enumerations/LogLevel) ## Classes -- [Logger](./classes/Logger.md) +- [Logger](./classes/Logger) ## Interfaces -- [LogData](./interfaces/LogData.md) -- [LoggerOptions](./interfaces/LoggerOptions.md) +- [LogData](./interfaces/LogData) +- [LoggerOptions](./interfaces/LoggerOptions) ## Type Aliases -- [ColorKey](./type-aliases/ColorKey.md) +- [ColorKey](./type-aliases/ColorKey) ## Variables -- [logger](./variables/logger.md) +- [logger](./variables/logger) diff --git a/sdks/typescript/api/logger/logger/interfaces/LoggerOptions.md b/sdks/typescript/api/logger/logger/interfaces/LoggerOptions.md index 6d5d567a..d59fb114 100644 --- a/sdks/typescript/api/logger/logger/interfaces/LoggerOptions.md +++ b/sdks/typescript/api/logger/logger/interfaces/LoggerOptions.md @@ -48,7 +48,7 @@ Whether to write logs to a file (server-side only) ### minLevel? -> `optional` **minLevel?**: [`LogLevel`](../enumerations/LogLevel.md) +> `optional` **minLevel?**: [`LogLevel`](../enumerations/LogLevel) Defined in: [logger.ts:84](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/logger/src/logger.ts#L84) diff --git a/sdks/typescript/api/logger/logger/variables/logger.md b/sdks/typescript/api/logger/logger/variables/logger.md index 86667d5d..6efabf94 100644 --- a/sdks/typescript/api/logger/logger/variables/logger.md +++ b/sdks/typescript/api/logger/logger/variables/logger.md @@ -1,5 +1,5 @@ # Variable: logger -> `const` **logger**: [`Logger`](../classes/Logger.md) +> `const` **logger**: [`Logger`](../classes/Logger) Defined in: [logger.ts:369](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/logger/src/logger.ts#L369) diff --git a/sdks/typescript/api/rate-limiting/index.md b/sdks/typescript/api/rate-limiting/index.md index f97a4637..fb4c9045 100644 --- a/sdks/typescript/api/rate-limiting/index.md +++ b/sdks/typescript/api/rate-limiting/index.md @@ -2,6 +2,6 @@ ## Modules -- [index](./index/index.md) -- [rate-limit](./rate-limit/index.md) -- [throttle](./throttle/index.md) +- [index](./index) +- [rate-limit](./rate-limit) +- [throttle](./throttle) diff --git a/sdks/typescript/api/rate-limiting/index/index.md b/sdks/typescript/api/rate-limiting/index/index.md index 14fcaa03..61f39bd9 100644 --- a/sdks/typescript/api/rate-limiting/index/index.md +++ b/sdks/typescript/api/rate-limiting/index/index.md @@ -4,136 +4,136 @@ ### debounce -Re-exports [debounce](../throttle/functions/debounce.md) +Re-exports [debounce](../throttle/functions/debounce) *** ### DebounceOptions -Re-exports [DebounceOptions](../throttle/type-aliases/DebounceOptions.md) +Re-exports [DebounceOptions](../throttle/type-aliases/DebounceOptions) *** ### DebounceOptionsSchema -Re-exports [DebounceOptionsSchema](../throttle/variables/DebounceOptionsSchema.md) +Re-exports [DebounceOptionsSchema](../throttle/variables/DebounceOptionsSchema) *** ### IRateLimitStore -Re-exports [IRateLimitStore](../rate-limit/interfaces/IRateLimitStore.md) +Re-exports [IRateLimitStore](../rate-limit/interfaces/IRateLimitStore) *** ### KeyedDebounce -Re-exports [KeyedDebounce](../throttle/classes/KeyedDebounce.md) +Re-exports [KeyedDebounce](../throttle/classes/KeyedDebounce) *** ### KeyedStats -Re-exports [KeyedStats](../throttle/type-aliases/KeyedStats.md) +Re-exports [KeyedStats](../throttle/type-aliases/KeyedStats) *** ### KeyedStatsSchema -Re-exports [KeyedStatsSchema](../throttle/variables/KeyedStatsSchema.md) +Re-exports [KeyedStatsSchema](../throttle/variables/KeyedStatsSchema) *** ### KeyedThrottle -Re-exports [KeyedThrottle](../throttle/classes/KeyedThrottle.md) +Re-exports [KeyedThrottle](../throttle/classes/KeyedThrottle) *** ### LeakyBucketLimiter -Re-exports [LeakyBucketLimiter](../throttle/classes/LeakyBucketLimiter.md) +Re-exports [LeakyBucketLimiter](../throttle/classes/LeakyBucketLimiter) *** ### MemoryRateLimitStore -Re-exports [MemoryRateLimitStore](../rate-limit/classes/MemoryRateLimitStore.md) +Re-exports [MemoryRateLimitStore](../rate-limit/classes/MemoryRateLimitStore) *** ### RATE\_LIMIT\_PRESETS -Re-exports [RATE_LIMIT_PRESETS](../rate-limit/variables/RATE_LIMIT_PRESETS.md) +Re-exports [RATE_LIMIT_PRESETS](../rate-limit/variables/RATE_LIMIT_PRESETS) *** ### RateLimitCheckResult -Re-exports [RateLimitCheckResult](../rate-limit/type-aliases/RateLimitCheckResult.md) +Re-exports [RateLimitCheckResult](../rate-limit/type-aliases/RateLimitCheckResult) *** ### RateLimitCheckResultSchema -Re-exports [RateLimitCheckResultSchema](../rate-limit/variables/RateLimitCheckResultSchema.md) +Re-exports [RateLimitCheckResultSchema](../rate-limit/variables/RateLimitCheckResultSchema) *** ### RateLimitConfig -Re-exports [RateLimitConfig](../rate-limit/type-aliases/RateLimitConfig.md) +Re-exports [RateLimitConfig](../rate-limit/type-aliases/RateLimitConfig) *** ### RateLimitConfigSchema -Re-exports [RateLimitConfigSchema](../rate-limit/variables/RateLimitConfigSchema.md) +Re-exports [RateLimitConfigSchema](../rate-limit/variables/RateLimitConfigSchema) *** ### RateLimiterStats -Re-exports [RateLimiterStats](../throttle/type-aliases/RateLimiterStats.md) +Re-exports [RateLimiterStats](../throttle/type-aliases/RateLimiterStats) *** ### RateLimiterStatsSchema -Re-exports [RateLimiterStatsSchema](../throttle/variables/RateLimiterStatsSchema.md) +Re-exports [RateLimiterStatsSchema](../throttle/variables/RateLimiterStatsSchema) *** ### RedisRateLimitStore -Re-exports [RedisRateLimitStore](../rate-limit/classes/RedisRateLimitStore.md) +Re-exports [RedisRateLimitStore](../rate-limit/classes/RedisRateLimitStore) *** ### SlidingWindowCounter -Re-exports [SlidingWindowCounter](../throttle/classes/SlidingWindowCounter.md) +Re-exports [SlidingWindowCounter](../throttle/classes/SlidingWindowCounter) *** ### throttle -Re-exports [throttle](../throttle/functions/throttle.md) +Re-exports [throttle](../throttle/functions/throttle) *** ### ThrottleOptions -Re-exports [ThrottleOptions](../throttle/type-aliases/ThrottleOptions.md) +Re-exports [ThrottleOptions](../throttle/type-aliases/ThrottleOptions) *** ### ThrottleOptionsSchema -Re-exports [ThrottleOptionsSchema](../throttle/variables/ThrottleOptionsSchema.md) +Re-exports [ThrottleOptionsSchema](../throttle/variables/ThrottleOptionsSchema) *** ### TokenBucketLimiter -Re-exports [TokenBucketLimiter](../throttle/classes/TokenBucketLimiter.md) +Re-exports [TokenBucketLimiter](../throttle/classes/TokenBucketLimiter) diff --git a/sdks/typescript/api/rate-limiting/rate-limit/classes/MemoryRateLimitStore.md b/sdks/typescript/api/rate-limiting/rate-limit/classes/MemoryRateLimitStore.md index dcaa9240..6a38f016 100644 --- a/sdks/typescript/api/rate-limiting/rate-limit/classes/MemoryRateLimitStore.md +++ b/sdks/typescript/api/rate-limiting/rate-limit/classes/MemoryRateLimitStore.md @@ -6,7 +6,7 @@ In-memory rate limit store for local development or simple services ## Implements -- [`IRateLimitStore`](../interfaces/IRateLimitStore.md) +- [`IRateLimitStore`](../interfaces/IRateLimitStore) ## Constructors @@ -46,7 +46,7 @@ Defined in: [rate-limit.ts:105](https://github.com/resq-software/npm/blob/f2ab5f #### Implementation of -[`IRateLimitStore`](../interfaces/IRateLimitStore.md).[`check`](../interfaces/IRateLimitStore.md#check) +[`IRateLimitStore`](../interfaces/IRateLimitStore).[`check`](../interfaces/IRateLimitStore#check) *** @@ -68,4 +68,4 @@ Defined in: [rate-limit.ts:130](https://github.com/resq-software/npm/blob/f2ab5f #### Implementation of -[`IRateLimitStore`](../interfaces/IRateLimitStore.md).[`reset`](../interfaces/IRateLimitStore.md#reset) +[`IRateLimitStore`](../interfaces/IRateLimitStore).[`reset`](../interfaces/IRateLimitStore#reset) diff --git a/sdks/typescript/api/rate-limiting/rate-limit/classes/RedisRateLimitStore.md b/sdks/typescript/api/rate-limiting/rate-limit/classes/RedisRateLimitStore.md index 53f7611b..0fab3389 100644 --- a/sdks/typescript/api/rate-limiting/rate-limit/classes/RedisRateLimitStore.md +++ b/sdks/typescript/api/rate-limiting/rate-limit/classes/RedisRateLimitStore.md @@ -6,7 +6,7 @@ Redis-backed rate limit store using @upstash/ratelimit ## Implements -- [`IRateLimitStore`](../interfaces/IRateLimitStore.md) +- [`IRateLimitStore`](../interfaces/IRateLimitStore) ## Constructors @@ -54,7 +54,7 @@ Defined in: [rate-limit.ts:81](https://github.com/resq-software/npm/blob/f2ab5fc #### Implementation of -[`IRateLimitStore`](../interfaces/IRateLimitStore.md).[`check`](../interfaces/IRateLimitStore.md#check) +[`IRateLimitStore`](../interfaces/IRateLimitStore).[`check`](../interfaces/IRateLimitStore#check) *** @@ -76,4 +76,4 @@ Defined in: [rate-limit.ts:93](https://github.com/resq-software/npm/blob/f2ab5fc #### Implementation of -[`IRateLimitStore`](../interfaces/IRateLimitStore.md).[`reset`](../interfaces/IRateLimitStore.md#reset) +[`IRateLimitStore`](../interfaces/IRateLimitStore).[`reset`](../interfaces/IRateLimitStore#reset) diff --git a/sdks/typescript/api/rate-limiting/rate-limit/index.md b/sdks/typescript/api/rate-limiting/rate-limit/index.md index ddc48d1e..b241951c 100644 --- a/sdks/typescript/api/rate-limiting/rate-limit/index.md +++ b/sdks/typescript/api/rate-limiting/rate-limit/index.md @@ -2,20 +2,20 @@ ## Classes -- [MemoryRateLimitStore](./classes/MemoryRateLimitStore.md) -- [RedisRateLimitStore](./classes/RedisRateLimitStore.md) +- [MemoryRateLimitStore](./classes/MemoryRateLimitStore) +- [RedisRateLimitStore](./classes/RedisRateLimitStore) ## Interfaces -- [IRateLimitStore](./interfaces/IRateLimitStore.md) +- [IRateLimitStore](./interfaces/IRateLimitStore) ## Type Aliases -- [RateLimitCheckResult](./type-aliases/RateLimitCheckResult.md) -- [RateLimitConfig](./type-aliases/RateLimitConfig.md) +- [RateLimitCheckResult](./type-aliases/RateLimitCheckResult) +- [RateLimitConfig](./type-aliases/RateLimitConfig) ## Variables -- [RATE\_LIMIT\_PRESETS](./variables/RATE_LIMIT_PRESETS.md) -- [RateLimitCheckResultSchema](./variables/RateLimitCheckResultSchema.md) -- [RateLimitConfigSchema](./variables/RateLimitConfigSchema.md) +- [RATE\_LIMIT\_PRESETS](./variables/RATE_LIMIT_PRESETS) +- [RateLimitCheckResultSchema](./variables/RateLimitCheckResultSchema) +- [RateLimitConfigSchema](./variables/RateLimitConfigSchema) diff --git a/sdks/typescript/api/rate-limiting/throttle/index.md b/sdks/typescript/api/rate-limiting/throttle/index.md index 39e2020a..360f74bd 100644 --- a/sdks/typescript/api/rate-limiting/throttle/index.md +++ b/sdks/typescript/api/rate-limiting/throttle/index.md @@ -2,27 +2,27 @@ ## Classes -- [KeyedDebounce](./classes/KeyedDebounce.md) -- [KeyedThrottle](./classes/KeyedThrottle.md) -- [LeakyBucketLimiter](./classes/LeakyBucketLimiter.md) -- [SlidingWindowCounter](./classes/SlidingWindowCounter.md) -- [TokenBucketLimiter](./classes/TokenBucketLimiter.md) +- [KeyedDebounce](./classes/KeyedDebounce) +- [KeyedThrottle](./classes/KeyedThrottle) +- [LeakyBucketLimiter](./classes/LeakyBucketLimiter) +- [SlidingWindowCounter](./classes/SlidingWindowCounter) +- [TokenBucketLimiter](./classes/TokenBucketLimiter) ## Type Aliases -- [DebounceOptions](./type-aliases/DebounceOptions.md) -- [KeyedStats](./type-aliases/KeyedStats.md) -- [RateLimiterStats](./type-aliases/RateLimiterStats.md) -- [ThrottleOptions](./type-aliases/ThrottleOptions.md) +- [DebounceOptions](./type-aliases/DebounceOptions) +- [KeyedStats](./type-aliases/KeyedStats) +- [RateLimiterStats](./type-aliases/RateLimiterStats) +- [ThrottleOptions](./type-aliases/ThrottleOptions) ## Variables -- [DebounceOptionsSchema](./variables/DebounceOptionsSchema.md) -- [KeyedStatsSchema](./variables/KeyedStatsSchema.md) -- [RateLimiterStatsSchema](./variables/RateLimiterStatsSchema.md) -- [ThrottleOptionsSchema](./variables/ThrottleOptionsSchema.md) +- [DebounceOptionsSchema](./variables/DebounceOptionsSchema) +- [KeyedStatsSchema](./variables/KeyedStatsSchema) +- [RateLimiterStatsSchema](./variables/RateLimiterStatsSchema) +- [ThrottleOptionsSchema](./variables/ThrottleOptionsSchema) ## Functions -- [debounce](./functions/debounce.md) -- [throttle](./functions/throttle.md) +- [debounce](./functions/debounce) +- [throttle](./functions/throttle) diff --git a/sdks/typescript/api/security/crypto/index.md b/sdks/typescript/api/security/crypto/index.md index 70b872aa..e58e1cb9 100644 --- a/sdks/typescript/api/security/crypto/index.md +++ b/sdks/typescript/api/security/crypto/index.md @@ -2,10 +2,10 @@ ## Functions -- [decryptData](./functions/decryptData.md) -- [encryptData](./functions/encryptData.md) -- [generateSecureToken](./functions/generateSecureToken.md) -- [hashData](./functions/hashData.md) -- [maskEmail](./functions/maskEmail.md) -- [maskPII](./functions/maskPII.md) -- [sanitizeForLogging](./functions/sanitizeForLogging.md) +- [decryptData](./functions/decryptData) +- [encryptData](./functions/encryptData) +- [generateSecureToken](./functions/generateSecureToken) +- [hashData](./functions/hashData) +- [maskEmail](./functions/maskEmail) +- [maskPII](./functions/maskPII) +- [sanitizeForLogging](./functions/sanitizeForLogging) diff --git a/sdks/typescript/api/security/index.md b/sdks/typescript/api/security/index.md index 65608dda..fad998c5 100644 --- a/sdks/typescript/api/security/index.md +++ b/sdks/typescript/api/security/index.md @@ -2,7 +2,7 @@ ## Modules -- [crypto](./crypto/index.md) -- [index](./index/index.md) -- [sanitize](./sanitize/index.md) -- [validators](./validators/index.md) +- [crypto](./crypto) +- [index](./index) +- [sanitize](./sanitize) +- [validators](./validators) diff --git a/sdks/typescript/api/security/index/index.md b/sdks/typescript/api/security/index/index.md index 648546b0..c922fbff 100644 --- a/sdks/typescript/api/security/index/index.md +++ b/sdks/typescript/api/security/index/index.md @@ -4,364 +4,364 @@ ### containsCommandInjection -Re-exports [containsCommandInjection](../validators/functions/containsCommandInjection.md) +Re-exports [containsCommandInjection](../validators/functions/containsCommandInjection) *** ### containsHomoglyphs -Re-exports [containsHomoglyphs](../validators/functions/containsHomoglyphs.md) +Re-exports [containsHomoglyphs](../validators/functions/containsHomoglyphs) *** ### containsNoSQLInjection -Re-exports [containsNoSQLInjection](../validators/functions/containsNoSQLInjection.md) +Re-exports [containsNoSQLInjection](../validators/functions/containsNoSQLInjection) *** ### containsPathTraversal -Re-exports [containsPathTraversal](../validators/functions/containsPathTraversal.md) +Re-exports [containsPathTraversal](../validators/functions/containsPathTraversal) *** ### containsSQLInjection -Re-exports [containsSQLInjection](../validators/functions/containsSQLInjection.md) +Re-exports [containsSQLInjection](../validators/functions/containsSQLInjection) *** ### containsXSSPatterns -Re-exports [containsXSSPatterns](../validators/functions/containsXSSPatterns.md) +Re-exports [containsXSSPatterns](../validators/functions/containsXSSPatterns) *** ### CreditCard -Re-exports [CreditCard](../sanitize/type-aliases/CreditCard.md) +Re-exports [CreditCard](../sanitize/type-aliases/CreditCard) *** ### CreditCardSchema -Re-exports [CreditCardSchema](../sanitize/variables/CreditCardSchema.md) +Re-exports [CreditCardSchema](../sanitize/variables/CreditCardSchema) *** ### decryptData -Re-exports [decryptData](../crypto/functions/decryptData.md) +Re-exports [decryptData](../crypto/functions/decryptData) *** ### detectThreatPatterns -Re-exports [detectThreatPatterns](../validators/functions/detectThreatPatterns.md) +Re-exports [detectThreatPatterns](../validators/functions/detectThreatPatterns) *** ### Email -Re-exports [Email](../sanitize/type-aliases/Email.md) +Re-exports [Email](../sanitize/type-aliases/Email) *** ### EmailSchema -Re-exports [EmailSchema](../sanitize/variables/EmailSchema.md) +Re-exports [EmailSchema](../sanitize/variables/EmailSchema) *** ### encryptData -Re-exports [encryptData](../crypto/functions/encryptData.md) +Re-exports [encryptData](../crypto/functions/encryptData) *** ### escapeHtml -Re-exports [escapeHtml](../sanitize/functions/escapeHtml.md) +Re-exports [escapeHtml](../sanitize/functions/escapeHtml) *** ### generateSecureToken -Re-exports [generateSecureToken](../crypto/functions/generateSecureToken.md) +Re-exports [generateSecureToken](../crypto/functions/generateSecureToken) *** ### getThreatErrorMessage -Re-exports [getThreatErrorMessage](../validators/functions/getThreatErrorMessage.md) +Re-exports [getThreatErrorMessage](../validators/functions/getThreatErrorMessage) *** ### hashData -Re-exports [hashData](../crypto/functions/hashData.md) +Re-exports [hashData](../crypto/functions/hashData) *** ### IPv4 -Re-exports [IPv4](../sanitize/type-aliases/IPv4.md) +Re-exports [IPv4](../sanitize/type-aliases/IPv4) *** ### IPv4Schema -Re-exports [IPv4Schema](../sanitize/variables/IPv4Schema.md) +Re-exports [IPv4Schema](../sanitize/variables/IPv4Schema) *** ### isSafeInput -Re-exports [isSafeInput](../validators/functions/isSafeInput.md) +Re-exports [isSafeInput](../validators/functions/isSafeInput) *** ### isValidEmail -Re-exports [isValidEmail](../sanitize/functions/isValidEmail.md) +Re-exports [isValidEmail](../sanitize/functions/isValidEmail) *** ### isValidPhone -Re-exports [isValidPhone](../sanitize/functions/isValidPhone.md) +Re-exports [isValidPhone](../sanitize/functions/isValidPhone) *** ### isValidSSN -Re-exports [isValidSSN](../sanitize/functions/isValidSSN.md) +Re-exports [isValidSSN](../sanitize/functions/isValidSSN) *** ### isValidUrl -Re-exports [isValidUrl](../sanitize/functions/isValidUrl.md) +Re-exports [isValidUrl](../sanitize/functions/isValidUrl) *** ### maskEmail -Re-exports [maskEmail](../crypto/functions/maskEmail.md) +Re-exports [maskEmail](../crypto/functions/maskEmail) *** ### maskPII -Re-exports [maskPII](../crypto/functions/maskPII.md) +Re-exports [maskPII](../crypto/functions/maskPII) *** ### normalizeUnicode -Re-exports [normalizeUnicode](../validators/functions/normalizeUnicode.md) +Re-exports [normalizeUnicode](../validators/functions/normalizeUnicode) *** ### parseJsonWithSchema -Re-exports [parseJsonWithSchema](../sanitize/functions/parseJsonWithSchema.md) +Re-exports [parseJsonWithSchema](../sanitize/functions/parseJsonWithSchema) *** ### PhoneNumber -Re-exports [PhoneNumber](../sanitize/type-aliases/PhoneNumber.md) +Re-exports [PhoneNumber](../sanitize/type-aliases/PhoneNumber) *** ### PhoneNumberSchema -Re-exports [PhoneNumberSchema](../sanitize/variables/PhoneNumberSchema.md) +Re-exports [PhoneNumberSchema](../sanitize/variables/PhoneNumberSchema) *** ### PIIRedactionOptions -Re-exports [PIIRedactionOptions](../sanitize/type-aliases/PIIRedactionOptions.md) +Re-exports [PIIRedactionOptions](../sanitize/type-aliases/PIIRedactionOptions) *** ### PIIRedactionOptionsSchema -Re-exports [PIIRedactionOptionsSchema](../sanitize/variables/PIIRedactionOptionsSchema.md) +Re-exports [PIIRedactionOptionsSchema](../sanitize/variables/PIIRedactionOptionsSchema) *** ### redactPII -Re-exports [redactPII](../sanitize/functions/redactPII.md) +Re-exports [redactPII](../sanitize/functions/redactPII) *** ### redactPIIEffect -Re-exports [redactPIIEffect](../sanitize/functions/redactPIIEffect.md) +Re-exports [redactPIIEffect](../sanitize/functions/redactPIIEffect) *** ### safeStringify -Re-exports [safeStringify](../sanitize/functions/safeStringify.md) +Re-exports [safeStringify](../sanitize/functions/safeStringify) *** ### SafeUrl -Re-exports [SafeUrl](../sanitize/type-aliases/SafeUrl.md) +Re-exports [SafeUrl](../sanitize/type-aliases/SafeUrl) *** ### SafeUrlSchema -Re-exports [SafeUrlSchema](../sanitize/variables/SafeUrlSchema.md) +Re-exports [SafeUrlSchema](../sanitize/variables/SafeUrlSchema) *** ### SanitizedString -Re-exports [SanitizedString](../sanitize/type-aliases/SanitizedString.md) +Re-exports [SanitizedString](../sanitize/type-aliases/SanitizedString) *** ### SanitizedStringSchema -Re-exports [SanitizedStringSchema](../sanitize/variables/SanitizedStringSchema.md) +Re-exports [SanitizedStringSchema](../sanitize/variables/SanitizedStringSchema) *** ### sanitizeForDisplay -Re-exports [sanitizeForDisplay](../validators/functions/sanitizeForDisplay.md) +Re-exports [sanitizeForDisplay](../validators/functions/sanitizeForDisplay) *** ### sanitizeForLogging -Re-exports [sanitizeForLogging](../crypto/functions/sanitizeForLogging.md) +Re-exports [sanitizeForLogging](../crypto/functions/sanitizeForLogging) *** ### sanitizeJson -Re-exports [sanitizeJson](../sanitize/functions/sanitizeJson.md) +Re-exports [sanitizeJson](../sanitize/functions/sanitizeJson) *** ### sanitizeUrl -Re-exports [sanitizeUrl](../sanitize/functions/sanitizeUrl.md) +Re-exports [sanitizeUrl](../sanitize/functions/sanitizeUrl) *** ### sanitizeUrlEffect -Re-exports [sanitizeUrlEffect](../sanitize/functions/sanitizeUrlEffect.md) +Re-exports [sanitizeUrlEffect](../sanitize/functions/sanitizeUrlEffect) *** ### SSN -Re-exports [SSN](../sanitize/type-aliases/SSN.md) +Re-exports [SSN](../sanitize/type-aliases/SSN) *** ### SSNSchema -Re-exports [SSNSchema](../sanitize/variables/SSNSchema.md) +Re-exports [SSNSchema](../sanitize/variables/SSNSchema) *** ### stripAnsi -Re-exports [stripAnsi](../sanitize/functions/stripAnsi.md) +Re-exports [stripAnsi](../sanitize/functions/stripAnsi) *** ### THREAT\_DETECTED\_MESSAGE -Re-exports [THREAT_DETECTED_MESSAGE](../validators/variables/THREAT_DETECTED_MESSAGE.md) +Re-exports [THREAT_DETECTED_MESSAGE](../validators/variables/THREAT_DETECTED_MESSAGE) *** ### ThreatDetectionConfig -Re-exports [ThreatDetectionConfig](../validators/interfaces/ThreatDetectionConfig.md) +Re-exports [ThreatDetectionConfig](../validators/interfaces/ThreatDetectionConfig) *** ### ThreatDetectionResult -Re-exports [ThreatDetectionResult](../validators/interfaces/ThreatDetectionResult.md) +Re-exports [ThreatDetectionResult](../validators/interfaces/ThreatDetectionResult) *** ### ThreatFinding -Re-exports [ThreatFinding](../validators/interfaces/ThreatFinding.md) +Re-exports [ThreatFinding](../validators/interfaces/ThreatFinding) *** ### ThreatType -Re-exports [ThreatType](../validators/type-aliases/ThreatType.md) +Re-exports [ThreatType](../validators/type-aliases/ThreatType) *** ### UrlProtocol -Re-exports [UrlProtocol](../sanitize/type-aliases/UrlProtocol.md) +Re-exports [UrlProtocol](../sanitize/type-aliases/UrlProtocol) *** ### UrlProtocolSchema -Re-exports [UrlProtocolSchema](../sanitize/variables/UrlProtocolSchema.md) +Re-exports [UrlProtocolSchema](../sanitize/variables/UrlProtocolSchema) *** ### UserInputOptions -Re-exports [UserInputOptions](../sanitize/type-aliases/UserInputOptions.md) +Re-exports [UserInputOptions](../sanitize/type-aliases/UserInputOptions) *** ### UserInputOptionsSchema -Re-exports [UserInputOptionsSchema](../sanitize/variables/UserInputOptionsSchema.md) +Re-exports [UserInputOptionsSchema](../sanitize/variables/UserInputOptionsSchema) *** ### validateSafeEmail -Re-exports [validateSafeEmail](../validators/functions/validateSafeEmail.md) +Re-exports [validateSafeEmail](../validators/functions/validateSafeEmail) *** ### validateSafeName -Re-exports [validateSafeName](../validators/functions/validateSafeName.md) +Re-exports [validateSafeName](../validators/functions/validateSafeName) *** ### validateSafeText -Re-exports [validateSafeText](../validators/functions/validateSafeText.md) +Re-exports [validateSafeText](../validators/functions/validateSafeText) *** ### validateUserInput -Re-exports [validateUserInput](../sanitize/functions/validateUserInput.md) +Re-exports [validateUserInput](../sanitize/functions/validateUserInput) *** ### validateUserInputEffect -Re-exports [validateUserInputEffect](../sanitize/functions/validateUserInputEffect.md) +Re-exports [validateUserInputEffect](../sanitize/functions/validateUserInputEffect) diff --git a/sdks/typescript/api/security/sanitize/index.md b/sdks/typescript/api/security/sanitize/index.md index 9561bded..decf8a46 100644 --- a/sdks/typescript/api/security/sanitize/index.md +++ b/sdks/typescript/api/security/sanitize/index.md @@ -2,44 +2,44 @@ ## Type Aliases -- [CreditCard](./type-aliases/CreditCard.md) -- [Email](./type-aliases/Email.md) -- [IPv4](./type-aliases/IPv4.md) -- [PhoneNumber](./type-aliases/PhoneNumber.md) -- [PIIRedactionOptions](./type-aliases/PIIRedactionOptions.md) -- [SafeUrl](./type-aliases/SafeUrl.md) -- [SanitizedString](./type-aliases/SanitizedString.md) -- [SSN](./type-aliases/SSN.md) -- [UrlProtocol](./type-aliases/UrlProtocol.md) -- [UserInputOptions](./type-aliases/UserInputOptions.md) +- [CreditCard](./type-aliases/CreditCard) +- [Email](./type-aliases/Email) +- [IPv4](./type-aliases/IPv4) +- [PhoneNumber](./type-aliases/PhoneNumber) +- [PIIRedactionOptions](./type-aliases/PIIRedactionOptions) +- [SafeUrl](./type-aliases/SafeUrl) +- [SanitizedString](./type-aliases/SanitizedString) +- [SSN](./type-aliases/SSN) +- [UrlProtocol](./type-aliases/UrlProtocol) +- [UserInputOptions](./type-aliases/UserInputOptions) ## Variables -- [CreditCardSchema](./variables/CreditCardSchema.md) -- [EmailSchema](./variables/EmailSchema.md) -- [IPv4Schema](./variables/IPv4Schema.md) -- [PhoneNumberSchema](./variables/PhoneNumberSchema.md) -- [PIIRedactionOptionsSchema](./variables/PIIRedactionOptionsSchema.md) -- [SafeUrlSchema](./variables/SafeUrlSchema.md) -- [SanitizedStringSchema](./variables/SanitizedStringSchema.md) -- [SSNSchema](./variables/SSNSchema.md) -- [UrlProtocolSchema](./variables/UrlProtocolSchema.md) -- [UserInputOptionsSchema](./variables/UserInputOptionsSchema.md) +- [CreditCardSchema](./variables/CreditCardSchema) +- [EmailSchema](./variables/EmailSchema) +- [IPv4Schema](./variables/IPv4Schema) +- [PhoneNumberSchema](./variables/PhoneNumberSchema) +- [PIIRedactionOptionsSchema](./variables/PIIRedactionOptionsSchema) +- [SafeUrlSchema](./variables/SafeUrlSchema) +- [SanitizedStringSchema](./variables/SanitizedStringSchema) +- [SSNSchema](./variables/SSNSchema) +- [UrlProtocolSchema](./variables/UrlProtocolSchema) +- [UserInputOptionsSchema](./variables/UserInputOptionsSchema) ## Functions -- [escapeHtml](./functions/escapeHtml.md) -- [isValidEmail](./functions/isValidEmail.md) -- [isValidPhone](./functions/isValidPhone.md) -- [isValidSSN](./functions/isValidSSN.md) -- [isValidUrl](./functions/isValidUrl.md) -- [parseJsonWithSchema](./functions/parseJsonWithSchema.md) -- [redactPII](./functions/redactPII.md) -- [redactPIIEffect](./functions/redactPIIEffect.md) -- [safeStringify](./functions/safeStringify.md) -- [sanitizeJson](./functions/sanitizeJson.md) -- [sanitizeUrl](./functions/sanitizeUrl.md) -- [sanitizeUrlEffect](./functions/sanitizeUrlEffect.md) -- [stripAnsi](./functions/stripAnsi.md) -- [validateUserInput](./functions/validateUserInput.md) -- [validateUserInputEffect](./functions/validateUserInputEffect.md) +- [escapeHtml](./functions/escapeHtml) +- [isValidEmail](./functions/isValidEmail) +- [isValidPhone](./functions/isValidPhone) +- [isValidSSN](./functions/isValidSSN) +- [isValidUrl](./functions/isValidUrl) +- [parseJsonWithSchema](./functions/parseJsonWithSchema) +- [redactPII](./functions/redactPII) +- [redactPIIEffect](./functions/redactPIIEffect) +- [safeStringify](./functions/safeStringify) +- [sanitizeJson](./functions/sanitizeJson) +- [sanitizeUrl](./functions/sanitizeUrl) +- [sanitizeUrlEffect](./functions/sanitizeUrlEffect) +- [stripAnsi](./functions/stripAnsi) +- [validateUserInput](./functions/validateUserInput) +- [validateUserInputEffect](./functions/validateUserInputEffect) diff --git a/sdks/typescript/api/security/validators/functions/containsCommandInjection.md b/sdks/typescript/api/security/validators/functions/containsCommandInjection.md index 1fcbe91c..c70480c0 100644 --- a/sdks/typescript/api/security/validators/functions/containsCommandInjection.md +++ b/sdks/typescript/api/security/validators/functions/containsCommandInjection.md @@ -1,6 +1,6 @@ # Function: containsCommandInjection() -> **containsCommandInjection**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding.md)[] +> **containsCommandInjection**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding)[] Defined in: [validators.ts:249](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L249) @@ -15,4 +15,4 @@ Note: This is strict - may trigger false positives on legitimate characters ## Returns -[`ThreatFinding`](../interfaces/ThreatFinding.md)[] +[`ThreatFinding`](../interfaces/ThreatFinding)[] diff --git a/sdks/typescript/api/security/validators/functions/containsHomoglyphs.md b/sdks/typescript/api/security/validators/functions/containsHomoglyphs.md index 40686226..33368cce 100644 --- a/sdks/typescript/api/security/validators/functions/containsHomoglyphs.md +++ b/sdks/typescript/api/security/validators/functions/containsHomoglyphs.md @@ -1,6 +1,6 @@ # Function: containsHomoglyphs() -> **containsHomoglyphs**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding.md)[] +> **containsHomoglyphs**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding)[] Defined in: [validators.ts:302](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L302) @@ -15,4 +15,4 @@ Used to detect phishing attempts using lookalike characters ## Returns -[`ThreatFinding`](../interfaces/ThreatFinding.md)[] +[`ThreatFinding`](../interfaces/ThreatFinding)[] diff --git a/sdks/typescript/api/security/validators/functions/containsNoSQLInjection.md b/sdks/typescript/api/security/validators/functions/containsNoSQLInjection.md index 706174b7..156f0b34 100644 --- a/sdks/typescript/api/security/validators/functions/containsNoSQLInjection.md +++ b/sdks/typescript/api/security/validators/functions/containsNoSQLInjection.md @@ -1,6 +1,6 @@ # Function: containsNoSQLInjection() -> **containsNoSQLInjection**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding.md)[] +> **containsNoSQLInjection**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding)[] Defined in: [validators.ts:227](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L227) @@ -14,4 +14,4 @@ Detects NoSQL injection patterns in input ## Returns -[`ThreatFinding`](../interfaces/ThreatFinding.md)[] +[`ThreatFinding`](../interfaces/ThreatFinding)[] diff --git a/sdks/typescript/api/security/validators/functions/containsPathTraversal.md b/sdks/typescript/api/security/validators/functions/containsPathTraversal.md index 17d4937b..b5fb4ec8 100644 --- a/sdks/typescript/api/security/validators/functions/containsPathTraversal.md +++ b/sdks/typescript/api/security/validators/functions/containsPathTraversal.md @@ -1,6 +1,6 @@ # Function: containsPathTraversal() -> **containsPathTraversal**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding.md)[] +> **containsPathTraversal**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding)[] Defined in: [validators.ts:280](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L280) @@ -14,4 +14,4 @@ Detects path traversal patterns in input ## Returns -[`ThreatFinding`](../interfaces/ThreatFinding.md)[] +[`ThreatFinding`](../interfaces/ThreatFinding)[] diff --git a/sdks/typescript/api/security/validators/functions/containsSQLInjection.md b/sdks/typescript/api/security/validators/functions/containsSQLInjection.md index 80c5a221..29b74379 100644 --- a/sdks/typescript/api/security/validators/functions/containsSQLInjection.md +++ b/sdks/typescript/api/security/validators/functions/containsSQLInjection.md @@ -1,6 +1,6 @@ # Function: containsSQLInjection() -> **containsSQLInjection**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding.md)[] +> **containsSQLInjection**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding)[] Defined in: [validators.ts:205](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L205) @@ -14,4 +14,4 @@ Detects SQL injection patterns in input ## Returns -[`ThreatFinding`](../interfaces/ThreatFinding.md)[] +[`ThreatFinding`](../interfaces/ThreatFinding)[] diff --git a/sdks/typescript/api/security/validators/functions/containsXSSPatterns.md b/sdks/typescript/api/security/validators/functions/containsXSSPatterns.md index d8837ed5..e8a86233 100644 --- a/sdks/typescript/api/security/validators/functions/containsXSSPatterns.md +++ b/sdks/typescript/api/security/validators/functions/containsXSSPatterns.md @@ -1,6 +1,6 @@ # Function: containsXSSPatterns() -> **containsXSSPatterns**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding.md)[] +> **containsXSSPatterns**(`input`): [`ThreatFinding`](../interfaces/ThreatFinding)[] Defined in: [validators.ts:182](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L182) @@ -14,4 +14,4 @@ Detects XSS attack patterns in input ## Returns -[`ThreatFinding`](../interfaces/ThreatFinding.md)[] +[`ThreatFinding`](../interfaces/ThreatFinding)[] diff --git a/sdks/typescript/api/security/validators/functions/detectThreatPatterns.md b/sdks/typescript/api/security/validators/functions/detectThreatPatterns.md index 4d5b8e9b..917685f3 100644 --- a/sdks/typescript/api/security/validators/functions/detectThreatPatterns.md +++ b/sdks/typescript/api/security/validators/functions/detectThreatPatterns.md @@ -1,6 +1,6 @@ # Function: detectThreatPatterns() -> **detectThreatPatterns**(`input`, `config?`): [`ThreatDetectionResult`](../interfaces/ThreatDetectionResult.md) +> **detectThreatPatterns**(`input`, `config?`): [`ThreatDetectionResult`](../interfaces/ThreatDetectionResult) Defined in: [validators.ts:352](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L352) @@ -16,12 +16,12 @@ The string to check ### config? -[`ThreatDetectionConfig`](../interfaces/ThreatDetectionConfig.md) = `DEFAULT_CONFIG` +[`ThreatDetectionConfig`](../interfaces/ThreatDetectionConfig) = `DEFAULT_CONFIG` Optional configuration for which checks to run ## Returns -[`ThreatDetectionResult`](../interfaces/ThreatDetectionResult.md) +[`ThreatDetectionResult`](../interfaces/ThreatDetectionResult) Detection result with any findings diff --git a/sdks/typescript/api/security/validators/functions/getThreatErrorMessage.md b/sdks/typescript/api/security/validators/functions/getThreatErrorMessage.md index 169c5a1f..2a068f89 100644 --- a/sdks/typescript/api/security/validators/functions/getThreatErrorMessage.md +++ b/sdks/typescript/api/security/validators/functions/getThreatErrorMessage.md @@ -10,7 +10,7 @@ Get human-readable error for a threat detection result ### result -[`ThreatDetectionResult`](../interfaces/ThreatDetectionResult.md) +[`ThreatDetectionResult`](../interfaces/ThreatDetectionResult) ## Returns diff --git a/sdks/typescript/api/security/validators/functions/isSafeInput.md b/sdks/typescript/api/security/validators/functions/isSafeInput.md index dd4e9733..5a64de46 100644 --- a/sdks/typescript/api/security/validators/functions/isSafeInput.md +++ b/sdks/typescript/api/security/validators/functions/isSafeInput.md @@ -16,7 +16,7 @@ The string to check ### config? -[`ThreatDetectionConfig`](../interfaces/ThreatDetectionConfig.md) +[`ThreatDetectionConfig`](../interfaces/ThreatDetectionConfig) Optional configuration diff --git a/sdks/typescript/api/security/validators/index.md b/sdks/typescript/api/security/validators/index.md index d2567534..4a1186db 100644 --- a/sdks/typescript/api/security/validators/index.md +++ b/sdks/typescript/api/security/validators/index.md @@ -2,31 +2,31 @@ ## Interfaces -- [ThreatDetectionConfig](./interfaces/ThreatDetectionConfig.md) -- [ThreatDetectionResult](./interfaces/ThreatDetectionResult.md) -- [ThreatFinding](./interfaces/ThreatFinding.md) +- [ThreatDetectionConfig](./interfaces/ThreatDetectionConfig) +- [ThreatDetectionResult](./interfaces/ThreatDetectionResult) +- [ThreatFinding](./interfaces/ThreatFinding) ## Type Aliases -- [ThreatType](./type-aliases/ThreatType.md) +- [ThreatType](./type-aliases/ThreatType) ## Variables -- [THREAT\_DETECTED\_MESSAGE](./variables/THREAT_DETECTED_MESSAGE.md) +- [THREAT\_DETECTED\_MESSAGE](./variables/THREAT_DETECTED_MESSAGE) ## Functions -- [containsCommandInjection](./functions/containsCommandInjection.md) -- [containsHomoglyphs](./functions/containsHomoglyphs.md) -- [containsNoSQLInjection](./functions/containsNoSQLInjection.md) -- [containsPathTraversal](./functions/containsPathTraversal.md) -- [containsSQLInjection](./functions/containsSQLInjection.md) -- [containsXSSPatterns](./functions/containsXSSPatterns.md) -- [detectThreatPatterns](./functions/detectThreatPatterns.md) -- [getThreatErrorMessage](./functions/getThreatErrorMessage.md) -- [isSafeInput](./functions/isSafeInput.md) -- [normalizeUnicode](./functions/normalizeUnicode.md) -- [sanitizeForDisplay](./functions/sanitizeForDisplay.md) -- [validateSafeEmail](./functions/validateSafeEmail.md) -- [validateSafeName](./functions/validateSafeName.md) -- [validateSafeText](./functions/validateSafeText.md) +- [containsCommandInjection](./functions/containsCommandInjection) +- [containsHomoglyphs](./functions/containsHomoglyphs) +- [containsNoSQLInjection](./functions/containsNoSQLInjection) +- [containsPathTraversal](./functions/containsPathTraversal) +- [containsSQLInjection](./functions/containsSQLInjection) +- [containsXSSPatterns](./functions/containsXSSPatterns) +- [detectThreatPatterns](./functions/detectThreatPatterns) +- [getThreatErrorMessage](./functions/getThreatErrorMessage) +- [isSafeInput](./functions/isSafeInput) +- [normalizeUnicode](./functions/normalizeUnicode) +- [sanitizeForDisplay](./functions/sanitizeForDisplay) +- [validateSafeEmail](./functions/validateSafeEmail) +- [validateSafeName](./functions/validateSafeName) +- [validateSafeText](./functions/validateSafeText) diff --git a/sdks/typescript/api/security/validators/interfaces/ThreatDetectionResult.md b/sdks/typescript/api/security/validators/interfaces/ThreatDetectionResult.md index 90b850ab..324db12d 100644 --- a/sdks/typescript/api/security/validators/interfaces/ThreatDetectionResult.md +++ b/sdks/typescript/api/security/validators/interfaces/ThreatDetectionResult.md @@ -14,6 +14,6 @@ Defined in: [validators.ts:161](https://github.com/resq-software/npm/blob/f2ab5f ### threats -> **threats**: [`ThreatFinding`](./ThreatFinding.md)[] +> **threats**: [`ThreatFinding`](./ThreatFinding)[] Defined in: [validators.ts:162](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L162) diff --git a/sdks/typescript/api/security/validators/interfaces/ThreatFinding.md b/sdks/typescript/api/security/validators/interfaces/ThreatFinding.md index ff604ec4..3b5089ce 100644 --- a/sdks/typescript/api/security/validators/interfaces/ThreatFinding.md +++ b/sdks/typescript/api/security/validators/interfaces/ThreatFinding.md @@ -22,6 +22,6 @@ Defined in: [validators.ts:168](https://github.com/resq-software/npm/blob/f2ab5f ### type -> **type**: [`ThreatType`](../type-aliases/ThreatType.md) +> **type**: [`ThreatType`](../type-aliases/ThreatType) Defined in: [validators.ts:166](https://github.com/resq-software/npm/blob/f2ab5fc82f4f501236bfdc25d86881be8e1fb643/packages/security/src/validators.ts#L166)