chore(jsapi): jsdoc fixes, missing types (#326)

- Updated all JSDoc references from `{@link}` to inline code formatting for consistency.
- Corrected a typo in the `Lister<T>` type description.
- Exported additional types: `PubHeaders`, `PrioritizedOptions`, `KvPurgeOptions`, and `KvKeyCodec`.

Signed-off-by: Alberto Ricart <[email protected]>

Author: aricart

jetstream/src/internal_mod.ts

@@ -147,6 +147,7 @@ export type {
   OverflowOptions,
   PeerInfo,
   Placement,
+  PrioritizedOptions,
   PriorityGroups,
   PriorityPolicy,
   PullOptions,

jetstream/src/jsapi_types.ts

@@ -608,7 +608,7 @@ export type StreamState = {
   "num_deleted": number;
   /**
    * IDs of messages that were deleted using the Message Delete API or Interest-based streams removing messages out of order
-   * {@link StreamInfoRequestOptions.deleted_details} is specified on
+   * when `StreamInfoRequestOptions.deleted_details` is specified on
    * the request.
    */
   deleted: number[];
@@ -1006,7 +1006,7 @@ export type ConsumerConfig = ConsumerUpdateConfig & {
    */
   "deliver_group"?: string;
   /**
-   * A unique name for a durable consumer. Set {@link name} for ephemeral consumers
+   * A unique name for a durable consumer. Set `name` for ephemeral consumers
    */
   "durable_name"?: string;
   /**
@@ -1120,12 +1120,12 @@ export type ConsumerUpdateConfig = PriorityGroups & {
   "mem_storage"?: boolean;
   /**
    * Deliver only messages that match the subject filter
-   * This is exclusive of {@link filter_subjects}
+   * This is exclusive of `filter_subjects`
    */
   "filter_subject"?: string;
   /**
    * Deliver only messages that match the specified filters.
-   * This is exclusive of {@link filter_subject}.
+   * This is exclusive of `filter_subject`.
    */
   "filter_subjects"?: string[];
   /**
@@ -1238,7 +1238,7 @@ export type PullOptions =
     "no_wait": boolean;
     /**
      * If set, the number of milliseconds to wait for the number of messages
-     * specified in {@link batch}
+     * specified in `batch`
      */
     expires: number;
     /**
@@ -1307,7 +1307,7 @@ export const PubHeaders = {
     "Nats-Expected-Last-Subject-Sequence-Subject",
   /**
    * Sets the TTL for a message (Nanos value). Only have effect on streams that
-   * enable {@link StreamConfig#allow_msg_ttl}.
+   * enable `StreamConfig.allow_msg_ttl`.
    */
   MessageTTL: "Nats-TTL",
   Schedule: "Nats-Schedule",

jetstream/src/mod.ts

@@ -26,6 +26,7 @@ export {
   JetStreamApiError,
   JetStreamError,
   JsHeaders,
+  PubHeaders,
   ReplayPolicy,
   RepublishHeaders,
   RetentionPolicy,
@@ -124,6 +125,7 @@ export type {
   OverflowOptions,
   PeerInfo,
   Placement,
+  PrioritizedOptions,
   PriorityGroups,
   PriorityPolicy,
   PubAck,

jetstream/src/types.ts

@@ -213,7 +213,7 @@ export type JetStreamPublishOptions = {
 
   /**
    * Sets {@link PubHeaders.MessageTTL} this only applies to streams that enable
-   * {@link StreamConfig#allow_msg_ttl}. The format of this value is "1s" or "1h",
+   * `StreamConfig.allow_msg_ttl`. The format of this value is "1s" or "1h",
    * etc, or a plain number interpreted as the number of seconds.
    */
   ttl?: string;
@@ -250,7 +250,7 @@ export type Destroyable = {
 };
 
 /**
- * An type for listing. Returns a promise with typed list.
+ * A generic type for listing. Returns a promise with typed list.
  */
 export type Lister<T> = {
   [Symbol.asyncIterator](): AsyncIterator<T>;

kv/src/internal_mod.ts

@@ -8,6 +8,7 @@ export type {
   KvLimits,
   KvOptions,
   KvPayloadCodec,
+  KvPurgeOptions,
   KvPutOptions,
   KvStatus,
   KvWatchEntry,

kv/src/mod.ts

@@ -4,8 +4,11 @@ export type {
   KvCodecs,
   KvDeleteOptions,
   KvEntry,
+  KvKeyCodec,
   KvLimits,
   KvOptions,
+  KvPayloadCodec,
+  KvPurgeOptions,
   KvPutOptions,
   KvStatus,
   KvWatchEntry,