Merge pull request #537 from nats-io/doc-types

moved reviver from jetstream to core
nats-io · Jun 15, 2023 · 606a977 · 606a977
2 parents aa66750 + 298d467
commit 606a977
Show file tree

Hide file tree

Showing 8 changed files with 25 additions and 17 deletions.
diff --git a/jetstream/jsm.ts b/jetstream/jsm.ts
@@ -25,7 +25,6 @@ import {
   DirectStreamAPI,
   JetStreamClient,
   JetStreamManager,
-  ReviverFn,
   StoredMsg,
   StreamAPI,
 } from "./types.ts";
@@ -34,6 +33,7 @@ import {
   Msg,
   MsgHdrs,
   NatsConnection,
+  ReviverFn,
 } from "../nats-base-client/core.ts";
 import {
   AccountInfoResponse,

diff --git a/jetstream/jsmstream_api.ts b/jetstream/jsmstream_api.ts
@@ -29,13 +29,16 @@ import {
   kvPrefix,
   KvStatus,
   ObjectStoreStatus,
-  ReviverFn,
   StoredMsg,
   Stream,
   StreamAPI,
   Streams,
 } from "./types.ts";
-import { JetStreamOptions, NatsConnection } from "../nats-base-client/core.ts";
+import {
+  JetStreamOptions,
+  NatsConnection,
+  ReviverFn,
+} from "../nats-base-client/core.ts";
 import {
   ApiPagedRequest,
   ExternalStream,

diff --git a/jetstream/types.ts b/jetstream/types.ts
@@ -21,6 +21,7 @@ import {
   NatsError,
   Payload,
   QueuedIterator,
+  ReviverFn,
   Sub,
 } from "../nats-base-client/core.ts";
 import { TypedSubscriptionOptions } from "../nats-base-client/typedsub.ts";
@@ -758,12 +759,6 @@ export interface DirectStreamAPI {
   getMessage(stream: string, query: DirectMsgRequest): Promise<StoredMsg>;
 }
 
-/**
- * A reviver function
- */
-//deno-lint-ignore no-explicit-any
-export type ReviverFn = (key: string, value: any) => any;
-
 /**
  * An interface representing a message that retrieved directly from JetStream.
  */

diff --git a/nats-base-client/core.ts b/nats-base-client/core.ts
@@ -13,11 +13,7 @@
  * limitations under the License.
  */
 
-import {
-  JetStreamClient,
-  JetStreamManager,
-  ReviverFn,
-} from "../jetstream/types.ts";
+import { JetStreamClient, JetStreamManager } from "../jetstream/types.ts";
 import { nuid } from "./nuid.ts";
 
 /**
@@ -649,6 +645,12 @@ export interface NatsConnection {
   services: ServicesAPI;
 }
 
+/**
+ * A reviver function
+ */
+//deno-lint-ignore no-explicit-any
+export type ReviverFn = (key: string, value: any) => any;
+
 /**
  * Represents a message delivered by NATS. This interface is used by
  * Subscribers.

diff --git a/nats-base-client/internal_mod.ts b/nats-base-client/internal_mod.ts
@@ -68,6 +68,7 @@ export type {
   PublishOptions,
   RequestManyOptions,
   RequestOptions,
+  ReviverFn,
   Server,
   ServerInfo,
   ServersChanged,

diff --git a/nats-base-client/mod.ts b/nats-base-client/mod.ts
@@ -61,6 +61,7 @@ export type {
   QueuedIterator,
   RequestManyOptions,
   RequestOptions,
+  ReviverFn,
   ServerInfo,
   ServersChanged,
   Service,

diff --git a/nats-base-client/msg.ts b/nats-base-client/msg.ts
@@ -16,8 +16,14 @@ import { MsgHdrsImpl } from "./headers.ts";
 import type { MsgArg } from "./parser.ts";
 import { Empty, TD } from "./encoders.ts";
 import { Codec, JSONCodec } from "./codec.ts";
-import { ErrorCode, Msg, MsgHdrs, NatsError, Publisher } from "./core.ts";
-import { ReviverFn } from "../jetstream/types.ts";
+import {
+  ErrorCode,
+  Msg,
+  MsgHdrs,
+  NatsError,
+  Publisher,
+  ReviverFn,
+} from "./core.ts";
 
 export function isRequestError(msg: Msg): NatsError | null {
   // NATS core only considers errors 503s on messages that have no payload

diff --git a/nats-base-client/service.ts b/nats-base-client/service.ts
@@ -33,6 +33,7 @@ import {
   Payload,
   PublishOptions,
   QueuedIterator,
+  ReviverFn,
   Service,
   ServiceConfig,
   ServiceError,
@@ -48,7 +49,6 @@ import {
   ServiceVerb,
   Sub,
 } from "./core.ts";
-import { ReviverFn } from "../jetstream/types.ts";
 
 /**
  * Services have common backplane subject pattern: