Skip to content

Commit

Permalink
docs: Update Entity docstring
Browse files Browse the repository at this point in the history
  • Loading branch information
ntucker committed Sep 27, 2024
1 parent 746266d commit 1f7b191
Show file tree
Hide file tree
Showing 8 changed files with 13 additions and 8 deletions.
5 changes: 5 additions & 0 deletions .changeset/stupid-sloths-wash.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@data-client/endpoint': patch
---

Update Entity docstring
2 changes: 1 addition & 1 deletion packages/endpoint/src/schema.js
Original file line number Diff line number Diff line change
Expand Up @@ -6,5 +6,5 @@ export { default as All } from './schemas/All.js';
export { default as Object } from './schemas/Object.js';
export { default as Invalidate } from './schemas/Invalidate.js';
export { default as Collection } from './schemas/Collection.js';
export { default as Entity } from './schemas/EntitySchema.js';
export { default as Entity } from './schemas/EntityMixin.js';
export { default as Query } from './schemas/Query.js';
2 changes: 1 addition & 1 deletion packages/endpoint/src/schemas/Entity.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ const EmptyBase = class {} as any as abstract new (...args: any[]) => {
};

/**
* Represents data that should be deduped by specifying a primary key.
* Entity defines a single (globally) unique object.
* @see https://dataclient.io/rest/api/Entity
*/
export default abstract class Entity extends EntityMixin(EmptyBase) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,15 @@ import type {
import { AbstractInstanceType } from '../normal.js';

/**
* Represents data that should be deduped by specifying a primary key.
* Entity defines a single (globally) unique object.
* @see https://dataclient.io/rest/api/schema.Entity
*/
export default function EntityMixin<TBase extends Constructor>(
Base: TBase,
options: EntityOptions<InstanceType<TBase>> = {},
) {
/**
* Represents data that should be deduped by specifying a primary key.
* Entity defines a single (globally) unique object.
* @see https://dataclient.io/rest/api/Entity
*/
abstract class EntityMixin extends Base {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1106,7 +1106,7 @@ declare const Entity_base: IEntityClass<abstract new (...args: any[]) => {
pk(parent?: any, key?: string, args?: readonly any[]): string | number | undefined;
});
/**
* Represents data that should be deduped by specifying a primary key.
* Entity defines a single (globally) unique object.
* @see https://dataclient.io/rest/api/Entity
*/
declare abstract class Entity extends Entity_base {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1106,7 +1106,7 @@ declare const Entity_base: IEntityClass<abstract new (...args: any[]) => {
pk(parent?: any, key?: string, args?: readonly any[]): string | number | undefined;
});
/**
* Represents data that should be deduped by specifying a primary key.
* Entity defines a single (globally) unique object.
* @see https://dataclient.io/rest/api/Entity
*/
declare abstract class Entity extends Entity_base {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1104,7 +1104,7 @@ declare const Entity_base: IEntityClass<abstract new (...args: any[]) => {
pk(parent?: any, key?: string, args?: readonly any[]): string | number | undefined;
});
/**
* Represents data that should be deduped by specifying a primary key.
* Entity defines a single (globally) unique object.
* @see https://dataclient.io/rest/api/Entity
*/
declare abstract class Entity extends Entity_base {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1108,7 +1108,7 @@ declare const Entity_base: IEntityClass<abstract new (...args: any[]) => {
pk(parent?: any, key?: string, args?: readonly any[]): string | number | undefined;
});
/**
* Represents data that should be deduped by specifying a primary key.
* Entity defines a single (globally) unique object.
* @see https://dataclient.io/rest/api/Entity
*/
declare abstract class Entity extends Entity_base {
Expand Down

0 comments on commit 1f7b191

Please sign in to comment.