Commit 1b1720e7 authored by ChanHaeng Lee's avatar ChanHaeng Lee
Browse files

Added `deprecated` to JSDoc

parent f09ef6cf

packages/fedify/src/x/cfworkers.ts

+12 −0
Original line number Diff line number Diff line
@@ -5,6 +5,10 @@ 
 * This module provides `KvStore` and `MessageQueue` implementations that use

 * Cloudflare Workers' KV and Queues bindings, respectively.

 *

 * @deprecated This module has been moved to a separate package.

 *             Install and import from `@fedify/cfworkers` instead.

 *             This module will be removed in Fedify v2.0.

 *

 * @module

 * @since 1.6.0

 */
@@ -33,6 +37,10 @@ interface KvMetadata { 
 * operation, as Cloudflare Workers KV does not support atomic compare-and-swap

 * operations.  If you need this functionality, consider using a different

 * key–value store that supports atomic operations.

 * 

 * @deprecated This class has been moved to `@fedify/cfworkers` package.

 *             Import `WorkersKvStore` from `@fedify/cfworkers` instead.

 *             This class will be removed in Fedify v2.0.

 * @since 1.6.0

 */

export class WorkersKvStore implements KvStore {
@@ -93,6 +101,10 @@ export class WorkersKvStore implements KvStore { 
 * way as other message queue systems.  Instead, you should use

 * the {@link Federation.processQueuedTask} method to process messages

 * passed to the queue.

 * 

 * @deprecated This class has been moved to `@fedify/cfworkers` package.

 *             Import `WorkersMessageQueue` from `@fedify/cfworkers` instead.

 *             This class will be removed in Fedify v2.0.

 * @since 1.6.0

 */

export class WorkersMessageQueue implements MessageQueue {

packages/fedify/src/x/denokv.ts

+12 −0
Original line number Diff line number Diff line
@@ -7,6 +7,10 @@ 
 * using Deno's KV store, and the `DenoKvMessageQueue` class implements the

 * `MessageQueue` interface using Deno's KV store.

 *

 * @deprecated This module has been moved to a separate package.

 *             Install and import from `@fedify/denokv` instead.

 *             This module will be removed in Fedify v2.0.

 *

 * @module

 * @since 0.5.0

 */
@@ -20,6 +24,10 @@ import type { 


/**

 * Represents a key–value store implementation using Deno's KV store.

 * 

 * @deprecated This class has been moved to `@fedify/denokv` package.

 *             Import `DenoKvStore` from `@fedify/denokv` instead.

 *             This class will be removed in Fedify v2.0.

 */

export class DenoKvStore implements KvStore {

  #kv: Deno.Kv;
@@ -93,6 +101,10 @@ export class DenoKvStore implements KvStore { 


/**

 * Represents a message queue adapter that uses Deno KV store.

 * 

 * @deprecated This class has been moved to `@fedify/denokv` package.

 *             Import `DenoKvMessageQueue` from `@fedify/denokv` instead.

 *             This class will be removed in Fedify v2.0.

 */

export class DenoKvMessageQueue implements MessageQueue, Disposable {

  #kv: Deno.Kv;

packages/fedify/src/x/fresh.ts

+16 −0
Original line number Diff line number Diff line
@@ -7,6 +7,12 @@ 
 *

 * [Fresh]: https://fresh.deno.dev/

 *

 * @deprecated This module is deprecated due to significant breaking changes

 *             in Fresh v2. A new integration for Fresh v2 will be implemented

 *             in a separate package in the future. Consider migrating to other

 *             frameworks supported by Fedify in the meantime.

 *             This module will be removed in Fedify v2.0.

 *

 * @module

 * @since 0.4.0

 */
@@ -23,6 +29,11 @@ interface FreshContext { 
 * Create options for the {@link Federation.fetch} method to integrate with

 * Fresh.

 *

 * @deprecated This function is deprecated due to significant breaking changes

 *             in Fresh v2. A new integration for Fresh v2 will be implemented

 *             in a separate package in the future.

 *             This function will be removed in Fedify v2.0.

 *

 * @example _middleware.ts

 * ``` typescript

 * import { integrateFetchOptions } from "@fedify/fedify/x/fresh";
@@ -76,6 +87,11 @@ export function integrateFetchOptions( 
 * Create a Fresh middleware handler to integrate with the {@link Federation}

 * object.

 *

 * @deprecated This function is deprecated due to significant breaking changes

 *             in Fresh v2. A new integration for Fresh v2 will be implemented

 *             in a separate package in the future.

 *             This function will be removed in Fedify v2.0.

 *

 * @example _middleware.ts

 * ``` typescript

 * import { integrateHandler } from "@fedify/fedify/x/fresh";

packages/fedify/src/x/hono.ts

+12 −0
Original line number Diff line number Diff line
@@ -6,6 +6,10 @@ 
 *

 * [Hono]: https://hono.dev/

 *

 * @deprecated This module has been moved to a separate package.

 *             Install and import from `@fedify/hono` instead.

 *             This module will be removed in Fedify v2.0.

 *

 * @module

 * @since 0.6.0

 */
@@ -32,6 +36,10 @@ type HonoMiddleware<THonoContext extends HonoContext> = ( 
 * A factory function to create a context data for the {@link Federation}

 * object.

 *

 * @deprecated This type has been moved to `@fedify/hono` package.

 *             Import `ContextDataFactory` from `@fedify/hono` instead.

 *             This type will be removed in Fedify v2.0.

 *

 * @template TContextData A type of the context data for the {@link Federation}

 *                         object.

 * @template THonoContext A type of the Hono context.
@@ -45,6 +53,10 @@ export type ContextDataFactory<TContextData, THonoContext> = ( 
/**

 * Create a Hono middleware to integrate with the {@link Federation} object.

 *

 * @deprecated This function has been moved to `@fedify/hono` package.

 *             Import `federation` from `@fedify/hono` instead.

 *             This function will be removed in Fedify v2.0.

 *

 * @template TContextData A type of the context data for the {@link Federation}

 *                         object.

 * @template THonoContext A type of the Hono context.

packages/fedify/src/x/sveltekit.ts

+8 −0
Original line number Diff line number Diff line
@@ -6,6 +6,10 @@ 
 *

 * [SvelteKit]: https://kit.svelte.dev/

 *

 * @deprecated This module has been moved to a separate package.

 *             Install and import from `@fedify/sveltekit` instead.

 *             This module will be removed in Fedify v2.0.

 *

 * @module

 * @since 1.3.0

 */
@@ -28,6 +32,10 @@ type HookParams = { 
 * Create a SvelteKit hook handler to integrate with the {@link Federation}

 * object.

 *

 * @deprecated This function has been moved to `@fedify/sveltekit` package.

 *             Import `fedifyHook` from `@fedify/sveltekit` instead.

 *             This function will be removed in Fedify v2.0.

 *

 * @example hooks.server.ts

 * ``` typescript

 * import { federation } from "./federation"; // Import the `Federation` object