Skip to content

Commit 011d615

Browse files
authored
docs: remove @example blocks to allow docs to deploy (#14636)
1 parent 874450a commit 011d615

File tree

3 files changed

+5
-26
lines changed

3 files changed

+5
-26
lines changed

.changeset/petite-lions-heal.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@sveltejs/kit': patch
3+
---
4+
5+
docs: remove `@example` blocks to allow docs to deploy

packages/kit/src/exports/public.d.ts

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1971,19 +1971,6 @@ type InvalidField<T> =
19711971
* If an issue is a `string`, it applies to the form as a whole (and will show up in `fields.allIssues()`)
19721972
* Access properties to create field-specific issues: `invalid.fieldName('message')`.
19731973
* The type structure mirrors the input data structure for type-safe field access.
1974-
*
1975-
* @example
1976-
* ```ts
1977-
* invalid('Username or password is invalid');
1978-
* ```
1979-
*
1980-
* @example
1981-
* ```ts
1982-
* invalid(
1983-
* invalid.username('Username is taken'),
1984-
* invalid.items[0].qty('Insufficient stock')
1985-
* );
1986-
* ```
19871974
*/
19881975
export type Invalid<Input = any> = ((...issues: Array<string | StandardSchemaV1.Issue>) => never) &
19891976
InvalidField<Input>;

packages/kit/types/index.d.ts

Lines changed: 0 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1947,19 +1947,6 @@ declare module '@sveltejs/kit' {
19471947
* If an issue is a `string`, it applies to the form as a whole (and will show up in `fields.allIssues()`)
19481948
* Access properties to create field-specific issues: `invalid.fieldName('message')`.
19491949
* The type structure mirrors the input data structure for type-safe field access.
1950-
*
1951-
* @example
1952-
* ```ts
1953-
* invalid('Username or password is invalid');
1954-
* ```
1955-
*
1956-
* @example
1957-
* ```ts
1958-
* invalid(
1959-
* invalid.username('Username is taken'),
1960-
* invalid.items[0].qty('Insufficient stock')
1961-
* );
1962-
* ```
19631950
*/
19641951
export type Invalid<Input = any> = ((...issues: Array<string | StandardSchemaV1.Issue>) => never) &
19651952
InvalidField<Input>;

0 commit comments

Comments
 (0)