docs(demos): createResource -> resource

ntucker · ntucker · commit 6fccfbc91507 · 2024-07-21T22:39:14.000+02:00
diff --git a/examples/coin-app/src/resources/Currency.ts b/examples/coin-app/src/resources/Currency.ts
@@ -1,4 +1,4 @@
-import { Entity, createResource, schema } from '@data-client/rest';
+import { Entity, resource, schema } from '@data-client/rest';
 
 import { iconTable } from './cryptoIconTable';
 import { Stats } from './Stats';
@@ -57,7 +57,7 @@ export class Currency extends Entity {
   };
 }
 
-export const CurrencyResource = createResource({
+export const CurrencyResource = resource({
   urlPrefix: 'https://api.exchange.coinbase.com',
   path: '/currencies/:id',
   schema: Currency,
diff --git a/examples/coin-app/src/resources/Product.ts b/examples/coin-app/src/resources/Product.ts
@@ -1,4 +1,4 @@
-import { Entity, createResource, schema } from '@data-client/rest';
+import { Entity, resource, schema } from '@data-client/rest';
 
 import { Stats } from './Stats';
 
@@ -25,7 +25,7 @@ export class Product extends Entity {
   }
 }
 
-export const ProductResource = createResource({
+export const ProductResource = resource({
   urlPrefix: 'https://api.exchange.coinbase.com',
   path: '/products/:id',
   schema: Product,
diff --git a/examples/coin-app/src/resources/Stats.ts b/examples/coin-app/src/resources/Stats.ts
@@ -1,4 +1,4 @@
-import { Entity, createResource, schema } from '@data-client/rest';
+import { Entity, resource, schema } from '@data-client/rest';
 
 export class Stats extends Entity {
   id = '';
@@ -31,7 +31,7 @@ export class Stats extends Entity {
   }
 }
 
-export const StatsResource = createResource({
+export const StatsResource = resource({
   urlPrefix: 'https://api.exchange.coinbase.com',
   path: '/products/:id/stats',
   schema: Stats,
diff --git a/examples/github-app/src/resources/Base.ts b/examples/github-app/src/resources/Base.ts
@@ -11,7 +11,7 @@ import {
   RestGenerics,
   RestEndpoint,
   Resource,
-  createResource,
+  resource,
   ResourceGenerics,
   ResourceOptions,
   PaginationFieldEndpoint,
@@ -90,10 +90,10 @@ export class GithubEndpoint<
   }
 }
 
-export function createGithubResource<O extends ResourceGenerics>(
+export function githubResource<O extends ResourceGenerics>(
   options: Readonly<O> & ResourceOptions,
 ): GithubResource<O> {
-  const baseResource = createResource({
+  const baseResource = resource({
     Endpoint: GithubEndpoint,
     paginationField: 'page',
     ...options,
diff --git a/examples/github-app/src/resources/Comment.ts b/examples/github-app/src/resources/Comment.ts
@@ -1,6 +1,6 @@
 import { Temporal } from '@js-temporal/polyfill';
 
-import { GithubEntity, createGithubResource } from './Base';
+import { GithubEntity, githubResource } from './Base';
 import { User } from './User';
 
 export class Comment extends GithubEntity {
@@ -28,7 +28,7 @@ export class Comment extends GithubEntity {
     updatedAt: Temporal.Instant.from,
   };
 }
-export const CommentResource = createGithubResource({
+export const CommentResource = githubResource({
   path: '/repos/:owner/:repo/issues/comments/:id',
   schema: Comment,
   optimistic: true,
diff --git a/examples/github-app/src/resources/Event.tsx b/examples/github-app/src/resources/Event.tsx
@@ -8,7 +8,7 @@ import {
 import { schema } from '@data-client/rest';
 import { Temporal } from '@js-temporal/polyfill';
 
-import { createGithubResource, GithubEntity } from './Base';
+import { githubResource, GithubEntity } from './Base';
 import { Issue } from './Issue';
 import PreviewEndpoint from './PreviewEndpoint';
 import { Pull } from './Pull';
@@ -80,7 +80,7 @@ export class IssuesEvent extends Event {
   };
 }
 
-export const EventResource = createGithubResource({
+export const EventResource = githubResource({
   path: '/users/:login/events/public/:id',
   schema: new schema.Union(
     {
diff --git a/examples/github-app/src/resources/Issue.tsx b/examples/github-app/src/resources/Issue.tsx
@@ -1,6 +1,6 @@
 import { Temporal } from '@js-temporal/polyfill';
 
-import { GithubEntity, createGithubResource } from './Base';
+import { GithubEntity, githubResource } from './Base';
 import { Label } from './Label';
 import { stateToIcon } from './stateToIcon';
 import { User } from './User';
@@ -51,7 +51,7 @@ export class Issue extends GithubEntity {
   }
 }
 
-export const IssueResource = createGithubResource({
+export const IssueResource = githubResource({
   path: '/repos/:owner/:repo/issues/:number',
   schema: Issue,
   pollFrequency: 60000,
diff --git a/examples/github-app/src/resources/Label.tsx b/examples/github-app/src/resources/Label.tsx
@@ -1,4 +1,4 @@
-import { GithubEntity, createGithubResource } from './Base';
+import { GithubEntity, githubResource } from './Base';
 import PreviewEndpoint from './PreviewEndpoint';
 
 export class Label extends GithubEntity {
@@ -12,7 +12,7 @@ export class Label extends GithubEntity {
     return this.id?.toString();
   }
 }
-export const LabelResource = createGithubResource({
+export const LabelResource = githubResource({
   path: '/repos/:owner/:repo/labels/:name',
   schema: Label,
   Endpoint: PreviewEndpoint,
diff --git a/examples/github-app/src/resources/Pull.ts b/examples/github-app/src/resources/Pull.ts
@@ -1,6 +1,6 @@
 import { Temporal } from '@js-temporal/polyfill';
 
-import { GithubEntity, createGithubResource } from './Base';
+import { GithubEntity, githubResource } from './Base';
 import { Label } from './Label';
 import { stateToIcon } from './stateToIcon';
 import { User } from './User';
@@ -51,7 +51,7 @@ export class Pull extends GithubEntity {
   static key = 'Pull';
 }
 
-export const PullResource = createGithubResource({
+export const PullResource = githubResource({
   path: '/repos/:owner/:repo/pulls/:number',
   schema: Pull,
   pollFrequency: 60000,
diff --git a/examples/github-app/src/resources/Reaction.tsx b/examples/github-app/src/resources/Reaction.tsx
@@ -1,7 +1,7 @@
 import { HeartOutlined } from '@ant-design/icons';
 import { Temporal } from '@js-temporal/polyfill';
 
-import { createGithubResource, GithubEntity } from './Base';
+import { githubResource, GithubEntity } from './Base';
 import PreviewEndpoint from './PreviewEndpoint';
 import { User } from './User';
 
@@ -24,7 +24,7 @@ export class Reaction extends GithubEntity {
   };
 }
 
-export const ReactionResource = createGithubResource({
+export const ReactionResource = githubResource({
   path: '/repos/:owner/:repo/issues/:number/reactions/:id',
   schema: Reaction,
   Endpoint: PreviewEndpoint,
diff --git a/examples/github-app/src/resources/Repository.tsx b/examples/github-app/src/resources/Repository.tsx
@@ -1,6 +1,6 @@
 import { Temporal } from '@js-temporal/polyfill';
 
-import { GithubEntity, createGithubResource, GithubGqlEndpoint } from './Base';
+import { GithubEntity, githubResource, GithubGqlEndpoint } from './Base';
 
 export class Repository extends GithubEntity {
   readonly name: string = '';
@@ -63,7 +63,7 @@ export class GqlRepository extends Repository {
   }
 }
 
-export const RepositoryResource = createGithubResource({
+export const RepositoryResource = githubResource({
   path: '/repos/:owner/:repo',
   schema: Repository,
 }).extend((base) => ({
diff --git a/examples/github-app/src/resources/User.ts b/examples/github-app/src/resources/User.ts
@@ -1,6 +1,6 @@
 import { Temporal } from '@js-temporal/polyfill';
 
-import { createGithubResource, GithubEndpoint, GithubEntity } from './Base';
+import { githubResource, GithubEndpoint, GithubEntity } from './Base';
 
 export class User extends GithubEntity {
   readonly nodeId: string = '';
@@ -47,7 +47,7 @@ export class User extends GithubEntity {
     return this.login;
   }
 }
-export const UserResource = createGithubResource({
+export const UserResource = githubResource({
   path: '/users/:login',
   schema: User,
 }).extend('current', {
diff --git a/examples/nextjs/resources/PlaceholderBaseResource.ts b/examples/nextjs/resources/PlaceholderBaseResource.ts
@@ -1,6 +1,6 @@
 import { Entity } from '@data-client/rest';
 import {
-  createResource,
+  resource,
   ResourceGenerics,
   ResourceOptions,
   Resource,
@@ -16,10 +16,10 @@ export abstract class PlaceholderEntity extends Entity {
 }
 
 /** Common patterns in the https://jsonplaceholder.typicode.com API */
-export function createPlaceholderResource<O extends ResourceGenerics = any>(
+export function placeholderResource<O extends ResourceGenerics = any>(
   options: Readonly<O> & ResourceOptions,
 ): Resource<O> {
-  return createResource({
+  return resource({
     ...options,
     urlPrefix: 'https://jsonplaceholder.typicode.com',
     // hour expiry time since we want to keep our example mutations and the api itself never actually changes
diff --git a/examples/nextjs/resources/TodoResource.ts b/examples/nextjs/resources/TodoResource.ts
@@ -1,7 +1,7 @@
 import { schema } from '@data-client/rest';
 
 import {
-  createPlaceholderResource,
+  placeholderResource,
   PlaceholderEntity,
 } from './PlaceholderBaseResource';
 
@@ -13,7 +13,7 @@ export class Todo extends PlaceholderEntity {
   static key = 'Todo';
 }
 
-export const TodoResource = createPlaceholderResource({
+export const TodoResource = placeholderResource({
   path: '/todos/:id',
   schema: Todo,
   optimistic: true,
diff --git a/examples/nextjs/resources/UserResource.ts b/examples/nextjs/resources/UserResource.ts
@@ -1,5 +1,5 @@
 import {
-  createPlaceholderResource,
+  placeholderResource,
   PlaceholderEntity,
 } from './PlaceholderBaseResource';
 
@@ -35,7 +35,7 @@ export class User extends PlaceholderEntity {
   static key = 'User';
 }
 
-export const UserResource = createPlaceholderResource({
+export const UserResource = placeholderResource({
   path: '/users/:id',
   schema: User,
 });
diff --git a/examples/todo-app/src/resources/PlaceholderBaseResource.ts b/examples/todo-app/src/resources/PlaceholderBaseResource.ts
@@ -1,6 +1,6 @@
 import { Entity } from '@data-client/rest';
 import {
-  createResource,
+  resource,
   ResourceGenerics,
   ResourceOptions,
   Resource,
@@ -17,10 +17,10 @@ export abstract class PlaceholderEntity extends Entity {
 }
 
 /** Common patterns in the https://jsonplaceholder.typicode.com API */
-export function createPlaceholderResource<O extends ResourceGenerics = any>(
+export function placeholderResource<O extends ResourceGenerics = any>(
   options: Readonly<O> & ResourceOptions,
 ): Resource<O> {
-  return createResource({
+  return resource({
     ...options,
     urlPrefix: 'https://jsonplaceholder.typicode.com',
     // hour expiry time since we want to keep our example mutations and the api itself never actually changes
diff --git a/examples/todo-app/src/resources/TodoResource.ts b/examples/todo-app/src/resources/TodoResource.ts
@@ -1,7 +1,7 @@
 import { schema } from '@data-client/rest';
 
 import {
-  createPlaceholderResource,
+  placeholderResource,
   PlaceholderEntity,
 } from './PlaceholderBaseResource';
 
@@ -13,7 +13,7 @@ export class Todo extends PlaceholderEntity {
   static key = 'Todo';
 }
 
-export const TodoResource = createPlaceholderResource({
+export const TodoResource = placeholderResource({
   path: '/todos/:id',
   schema: Todo,
   optimistic: true,
diff --git a/examples/todo-app/src/resources/UserResource.ts b/examples/todo-app/src/resources/UserResource.ts
@@ -1,5 +1,5 @@
 import {
-  createPlaceholderResource,
+  placeholderResource,
   PlaceholderEntity,
 } from './PlaceholderBaseResource';
 
@@ -35,7 +35,7 @@ export class User extends PlaceholderEntity {
   static key = 'User';
 }
 
-export const UserResource = createPlaceholderResource({
+export const UserResource = placeholderResource({
   path: '/users/:id',
   schema: User,
 });

Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-import { Entity, createResource, schema } from '@data-client/rest';`
	`1`	`+import { Entity, resource, schema } from '@data-client/rest';`
`2`	`2`
`3`	`3`	`import { Stats } from './Stats';`
`4`	`4`
`@@ -25,7 +25,7 @@ export class Product extends Entity {`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`
`28`		`-export const ProductResource = createResource({`
	`28`	`+export const ProductResource = resource({`
`29`	`29`	`urlPrefix: 'https://api.exchange.coinbase.com',`
`30`	`30`	`path: '/products/:id',`
`31`	`31`	`schema: Product,`
Original file line number	Diff line number	Diff line change
`@@ -1,6 +1,6 @@`
`1`	`1`	`import { Temporal } from '@js-temporal/polyfill';`
`2`	`2`
`3`		`-import { GithubEntity, createGithubResource } from './Base';`
	`3`	`+import { GithubEntity, githubResource } from './Base';`
`4`	`4`	`import { Label } from './Label';`
`5`	`5`	`import { stateToIcon } from './stateToIcon';`
`6`	`6`	`import { User } from './User';`
`@@ -51,7 +51,7 @@ export class Issue extends GithubEntity {`
`51`	`51`	`}`
`52`	`52`	`}`
`53`	`53`
`54`		`-export const IssueResource = createGithubResource({`
	`54`	`+export const IssueResource = githubResource({`
`55`	`55`	`path: '/repos/:owner/:repo/issues/:number',`
`56`	`56`	`schema: Issue,`
`57`	`57`	`pollFrequency: 60000,`