Skip to content

Commit 4580e62

Browse files
committed
docs: Update docstring for EntityMixin
1 parent 38596f6 commit 4580e62

File tree

7 files changed

+18
-16
lines changed

7 files changed

+18
-16
lines changed

.changeset/purple-dodos-drop.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
---
2+
'@data-client/endpoint': patch
3+
'@data-client/graphql': patch
4+
'@data-client/rest': patch
5+
---
6+
7+
Update docstring for EntityMixin

packages/endpoint/src/schema.d.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -411,10 +411,9 @@ export declare class Collection<
411411
Parent = any,
412412
> extends CollectionRoot<S, Args, Parent> {}
413413

414-
// id is in Instance, so we default to that as pk
415414
/**
416-
* Represents data that should be deduped by specifying a primary key.
417-
* @see https://dataclient.io/docs/api/schema.Entity
415+
* Entity defines a single (globally) unique object.
416+
* @see https://dataclient.io/rest/api/schema.Entity
418417
*/
419418
export function Entity<TBase extends PKClass>(
420419
Base: TBase,

website/src/components/Playground/editor-types/@data-client/endpoint.d.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,10 +1010,9 @@ declare class Collection<
10101010
Parent = any,
10111011
> extends CollectionRoot<S, Args, Parent> {}
10121012

1013-
// id is in Instance, so we default to that as pk
10141013
/**
1015-
* Represents data that should be deduped by specifying a primary key.
1016-
* @see https://dataclient.io/docs/api/schema.Entity
1014+
* Entity defines a single (globally) unique object.
1015+
* @see https://dataclient.io/rest/api/schema.Entity
10171016
*/
10181017
declare function Entity$1<TBase extends PKClass>(
10191018
Base: TBase,

website/src/components/Playground/editor-types/@data-client/graphql.d.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1010,10 +1010,9 @@ declare class Collection<
10101010
Parent = any,
10111011
> extends CollectionRoot<S, Args, Parent> {}
10121012

1013-
// id is in Instance, so we default to that as pk
10141013
/**
1015-
* Represents data that should be deduped by specifying a primary key.
1016-
* @see https://dataclient.io/docs/api/schema.Entity
1014+
* Entity defines a single (globally) unique object.
1015+
* @see https://dataclient.io/rest/api/schema.Entity
10171016
*/
10181017
declare function Entity$1<TBase extends PKClass>(
10191018
Base: TBase,

website/src/components/Playground/editor-types/@data-client/rest.d.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1008,10 +1008,9 @@ declare class Collection<
10081008
Parent = any,
10091009
> extends CollectionRoot<S, Args, Parent> {}
10101010

1011-
// id is in Instance, so we default to that as pk
10121011
/**
1013-
* Represents data that should be deduped by specifying a primary key.
1014-
* @see https://dataclient.io/docs/api/schema.Entity
1012+
* Entity defines a single (globally) unique object.
1013+
* @see https://dataclient.io/rest/api/schema.Entity
10151014
*/
10161015
declare function Entity$1<TBase extends PKClass>(
10171016
Base: TBase,

website/src/components/Playground/editor-types/globals.d.ts

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1012,10 +1012,9 @@ declare class Collection<
10121012
Parent = any,
10131013
> extends CollectionRoot<S, Args, Parent> {}
10141014

1015-
// id is in Instance, so we default to that as pk
10161015
/**
1017-
* Represents data that should be deduped by specifying a primary key.
1018-
* @see https://dataclient.io/docs/api/schema.Entity
1016+
* Entity defines a single (globally) unique object.
1017+
* @see https://dataclient.io/rest/api/schema.Entity
10191018
*/
10201019
declare function Entity$1<TBase extends PKClass>(
10211020
Base: TBase,

website/src/components/Playground/editor-types/react.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2899,6 +2899,7 @@ declare namespace React {
28992899

29002900
// Standard HTML Attributes
29012901
accessKey?: string | undefined;
2902+
autoCapitalize?: "off" | "none" | "on" | "sentences" | "words" | "characters" | undefined | (string & {});
29022903
autoFocus?: boolean | undefined;
29032904
className?: string | undefined;
29042905
contentEditable?: Booleanish | "inherit" | "plaintext-only" | undefined;
@@ -2937,7 +2938,6 @@ declare namespace React {
29372938
vocab?: string | undefined;
29382939

29392940
// Non-standard Attributes
2940-
autoCapitalize?: string | undefined;
29412941
autoCorrect?: string | undefined;
29422942
autoSave?: string | undefined;
29432943
color?: string | undefined;

0 commit comments

Comments
 (0)