@ttsc/factory 0.15.6 → 0.15.8

package/src/factory/jsdoc/createJSDocParameterTag.ts

@@ -0,0 +1,58 @@
+import type {
+  EntityName,
+  Identifier,
+  JSDocComment,
+  JSDocParameterTag,
+  JSDocTypeExpression,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocParameterTag}: a `@param` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `param` when omitted. The
+ * `name` is the documented parameter, `isBracketed` wraps that name in square
+ * brackets to mark it optional, and `typeExpression` supplies the brace-wrapped
+ * type. The `isNameFirst` flag controls ordering: when `true` the name prints
+ * before the type, when `false` the type prints first. The `comment` is the
+ * trailing description.
+ *
+ * With the default tag name, name `x`, a `{number}` type expression, and a `the
+ * x` comment, `isNameFirst` of `true` prints the name ahead of the type:
+ *
+ * ```ts
+ * @param x {number} the x
+ * ```
+ *
+ * The same inputs with `isNameFirst` of `false` print the type first:
+ *
+ * ```ts
+ * @param {number} x the x
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `param`.
+ * @param name The parameter name.
+ * @param isBracketed Whether the name was wrapped in brackets.
+ * @param typeExpression The type expression, if any.
+ * @param isNameFirst Whether the name was written before the type.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocParameterTag}.
+ */
+export const createJSDocParameterTag = (
+  tagName: Identifier | undefined,
+  name: EntityName,
+  isBracketed: boolean,
+  typeExpression?: JSDocTypeExpression,
+  isNameFirst: boolean = false,
+  comment?: string | readonly JSDocComment[],
+): JSDocParameterTag =>
+  make("JSDocParameterTag", {
+    tagName: tagName ?? createIdentifier("param"),
+    name,
+    isBracketed,
+    typeExpression,
+    isNameFirst: !!isNameFirst,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocPrivateTag.ts

@@ -0,0 +1,29 @@
+import type { Identifier, JSDocComment, JSDocPrivateTag } from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocPrivateTag}: a `@private` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `private` when omitted. The
+ * `comment` is the trailing description, if any.
+ *
+ * With the default tag name and no comment, the printer emits:
+ *
+ * ```ts
+ * @private
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `private`.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocPrivateTag}.
+ */
+export const createJSDocPrivateTag = (
+  tagName: Identifier | undefined,
+  comment?: string | readonly JSDocComment[],
+): JSDocPrivateTag =>
+  make("JSDocPrivateTag", {
+    tagName: tagName ?? createIdentifier("private"),
+    comment,
+  });

package/src/factory/jsdoc/createJSDocPropertyTag.ts

@@ -0,0 +1,52 @@
+import type {
+  EntityName,
+  Identifier,
+  JSDocComment,
+  JSDocPropertyTag,
+  JSDocTypeExpression,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocPropertyTag}: a `@prop` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `prop` when omitted. The `name`
+ * is the documented property, `isBracketed` wraps that name in square brackets
+ * to mark it optional, and `typeExpression` supplies the brace-wrapped type.
+ * The `isNameFirst` flag controls ordering: when `true` the name prints before
+ * the type, when `false` the type prints first. The `comment` is the trailing
+ * description.
+ *
+ * With the default tag name, name `x`, a `{number}` type expression, `the x`
+ * comment, and `isNameFirst` of `true`, the printer emits:
+ *
+ * ```ts
+ * @prop x {number} the x
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `prop`.
+ * @param name The property name.
+ * @param isBracketed Whether the name was wrapped in brackets.
+ * @param typeExpression The type expression, if any.
+ * @param isNameFirst Whether the name was written before the type.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocPropertyTag}.
+ */
+export const createJSDocPropertyTag = (
+  tagName: Identifier | undefined,
+  name: EntityName,
+  isBracketed: boolean,
+  typeExpression?: JSDocTypeExpression,
+  isNameFirst: boolean = false,
+  comment?: string | readonly JSDocComment[],
+): JSDocPropertyTag =>
+  make("JSDocPropertyTag", {
+    tagName: tagName ?? createIdentifier("prop"),
+    name,
+    isBracketed,
+    typeExpression,
+    isNameFirst: !!isNameFirst,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocProtectedTag.ts

@@ -0,0 +1,29 @@
+import type { Identifier, JSDocComment, JSDocProtectedTag } from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocProtectedTag}: a `@protected` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `protected` when omitted. The
+ * `comment` is the trailing description, if any.
+ *
+ * With the default tag name and no comment, the printer emits:
+ *
+ * ```ts
+ * @protected
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `protected`.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocProtectedTag}.
+ */
+export const createJSDocProtectedTag = (
+  tagName: Identifier | undefined,
+  comment?: string | readonly JSDocComment[],
+): JSDocProtectedTag =>
+  make("JSDocProtectedTag", {
+    tagName: tagName ?? createIdentifier("protected"),
+    comment,
+  });

package/src/factory/jsdoc/createJSDocPublicTag.ts

@@ -0,0 +1,29 @@
+import type { Identifier, JSDocComment, JSDocPublicTag } from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocPublicTag}: a `@public` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `public` when omitted. The
+ * `comment` is the trailing description, if any.
+ *
+ * With the default tag name and no comment, the printer emits:
+ *
+ * ```ts
+ * @public
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `public`.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocPublicTag}.
+ */
+export const createJSDocPublicTag = (
+  tagName: Identifier | undefined,
+  comment?: string | readonly JSDocComment[],
+): JSDocPublicTag =>
+  make("JSDocPublicTag", {
+    tagName: tagName ?? createIdentifier("public"),
+    comment,
+  });

package/src/factory/jsdoc/createJSDocReadonlyTag.ts

@@ -0,0 +1,29 @@
+import type { Identifier, JSDocComment, JSDocReadonlyTag } from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocReadonlyTag}: a `@readonly` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `readonly` when omitted. The
+ * `comment` is the trailing description, if any.
+ *
+ * With the default tag name and no comment, the printer emits:
+ *
+ * ```ts
+ * @readonly
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `readonly`.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocReadonlyTag}.
+ */
+export const createJSDocReadonlyTag = (
+  tagName: Identifier | undefined,
+  comment?: string | readonly JSDocComment[],
+): JSDocReadonlyTag =>
+  make("JSDocReadonlyTag", {
+    tagName: tagName ?? createIdentifier("readonly"),
+    comment,
+  });

package/src/factory/jsdoc/createJSDocReturnTag.ts

@@ -0,0 +1,40 @@
+import type {
+  Identifier,
+  JSDocComment,
+  JSDocReturnTag,
+  JSDocTypeExpression,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocReturnTag}: a `@returns` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `returns` when omitted. The
+ * `typeExpression` supplies the brace-wrapped return type, and `comment` is the
+ * trailing description. When the type expression is omitted, the printer drops
+ * the braces and emits only the tag name and comment.
+ *
+ * With the default tag name, a `{number}` type expression, and a `the count`
+ * comment, the printer emits:
+ *
+ * ```ts
+ * @returns {number} the count
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `returns`.
+ * @param typeExpression The type expression, if any.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocReturnTag}.
+ */
+export const createJSDocReturnTag = (
+  tagName: Identifier | undefined,
+  typeExpression?: JSDocTypeExpression,
+  comment?: string | readonly JSDocComment[],
+): JSDocReturnTag =>
+  make("JSDocReturnTag", {
+    tagName: tagName ?? createIdentifier("returns"),
+    typeExpression,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocSatisfiesTag.ts

@@ -0,0 +1,39 @@
+import type {
+  Identifier,
+  JSDocComment,
+  JSDocSatisfiesTag,
+  JSDocTypeExpression,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocSatisfiesTag}: a `@satisfies` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `satisfies` when omitted. The
+ * `typeExpression` supplies the brace-wrapped target type, and `comment` is the
+ * trailing description.
+ *
+ * With the default tag name, a `{Foo}` type expression, and an `ok` comment,
+ * the printer emits:
+ *
+ * ```ts
+ * @satisfies {Foo} ok
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `satisfies`.
+ * @param typeExpression The type expression.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocSatisfiesTag}.
+ */
+export const createJSDocSatisfiesTag = (
+  tagName: Identifier | undefined,
+  typeExpression: JSDocTypeExpression,
+  comment?: string | readonly JSDocComment[],
+): JSDocSatisfiesTag =>
+  make("JSDocSatisfiesTag", {
+    tagName: tagName ?? createIdentifier("satisfies"),
+    typeExpression,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocSeeTag.ts

@@ -0,0 +1,39 @@
+import type {
+  Identifier,
+  JSDocComment,
+  JSDocNameReference,
+  JSDocSeeTag,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocSeeTag}: a `@see` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `see` when omitted. The
+ * `nameExpression` is the referenced name, if any, and `comment` is the
+ * trailing description.
+ *
+ * With the default tag name, a `Foo` name reference, and a `more` comment, the
+ * printer emits:
+ *
+ * ```ts
+ * @see Foo more
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `see`.
+ * @param nameExpression The referenced name, if any.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocSeeTag}.
+ */
+export const createJSDocSeeTag = (
+  tagName: Identifier | undefined,
+  nameExpression: JSDocNameReference | undefined,
+  comment?: string | readonly JSDocComment[],
+): JSDocSeeTag =>
+  make("JSDocSeeTag", {
+    tagName: tagName ?? createIdentifier("see"),
+    name: nameExpression,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocSignature.ts

@@ -0,0 +1,40 @@
+import type {
+  JSDocParameterTag,
+  JSDocReturnTag,
+  JSDocSignature,
+  JSDocTemplateTag,
+} from "../../ast";
+import { make } from "../internal/make";
+
+/**
+ * Create a {@link JSDocSignature}: the synthetic signature behind `@callback`
+ * and `@overload` tags.
+ *
+ * The `typeParameters` are the `@template` tags, `parameters` are the `@param`
+ * tags, and `type` is the `@returns` tag. The printer emits each on its own
+ * line, in that order.
+ *
+ * With no type parameters, a single `@param {number} x the x` tag, and an
+ * `@returns {boolean}` tag, the printer emits:
+ *
+ * ```ts
+ * @param {number} x the x
+ * @returns {boolean}
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param typeParameters The `@template` type parameters, if any.
+ * @param parameters The `@param` tags.
+ * @param type The `@return` tag, if any.
+ * @returns The created {@link JSDocSignature}.
+ */
+export const createJSDocSignature = (
+  typeParameters: readonly JSDocTemplateTag[] | undefined,
+  parameters: readonly JSDocParameterTag[],
+  type?: JSDocReturnTag,
+): JSDocSignature =>
+  make("JSDocSignature", {
+    typeParameters,
+    parameters,
+    type,
+  });

package/src/factory/jsdoc/createJSDocTemplateTag.ts

@@ -0,0 +1,44 @@
+import type {
+  Identifier,
+  JSDocComment,
+  JSDocTemplateTag,
+  JSDocTypeExpression,
+  TypeParameterDeclaration,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocTemplateTag}: a `@template` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `template` when omitted. The
+ * `constraint` is the shared brace-wrapped bound applied to every declared
+ * parameter, if any. The `typeParameters` are the declared names, and `comment`
+ * is the trailing description.
+ *
+ * With the default tag name, a `{string}` constraint, and a single `T` type
+ * parameter, the printer emits:
+ *
+ * ```ts
+ * @template {string} T
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `template`.
+ * @param constraint The shared constraint, if any.
+ * @param typeParameters The declared type parameters.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocTemplateTag}.
+ */
+export const createJSDocTemplateTag = (
+  tagName: Identifier | undefined,
+  constraint: JSDocTypeExpression | undefined,
+  typeParameters: readonly TypeParameterDeclaration[],
+  comment?: string | readonly JSDocComment[],
+): JSDocTemplateTag =>
+  make("JSDocTemplateTag", {
+    tagName: tagName ?? createIdentifier("template"),
+    constraint,
+    typeParameters,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocText.ts

@@ -0,0 +1,24 @@
+import type { JSDocText } from "../../ast";
+import { make } from "../internal/make";
+
+/**
+ * Create a {@link JSDocText}: a run of plain text inside a JSDoc comment.
+ *
+ * The `text` is the literal content. The printer emits it verbatim, with no
+ * decoration. This node holds the prose that sits between inline tags in a
+ * comment body.
+ *
+ * With a `hello world` text, the printer emits:
+ *
+ * ```ts
+ * hello world
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param text The textual content.
+ * @returns The created {@link JSDocText}.
+ */
+export const createJSDocText = (text: string): JSDocText =>
+  make("JSDocText", {
+    text,
+  });

package/src/factory/jsdoc/createJSDocThisTag.ts

@@ -0,0 +1,38 @@
+import type {
+  Identifier,
+  JSDocComment,
+  JSDocThisTag,
+  JSDocTypeExpression,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocThisTag}: a `@this` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `this` when omitted. The
+ * `typeExpression` supplies the brace-wrapped `this` type, and `comment` is the
+ * trailing description, if any.
+ *
+ * With the default tag name and a `{Foo}` type expression, the printer emits:
+ *
+ * ```ts
+ * @this {Foo}
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `this`.
+ * @param typeExpression The type expression.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocThisTag}.
+ */
+export const createJSDocThisTag = (
+  tagName: Identifier | undefined,
+  typeExpression: JSDocTypeExpression,
+  comment?: string | readonly JSDocComment[],
+): JSDocThisTag =>
+  make("JSDocThisTag", {
+    tagName: tagName ?? createIdentifier("this"),
+    typeExpression,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocThrowsTag.ts

@@ -0,0 +1,38 @@
+import type {
+  Identifier,
+  JSDocComment,
+  JSDocThrowsTag,
+  JSDocTypeExpression,
+} from "../../ast";
+import { make } from "../internal/make";
+
+/**
+ * Create a {@link JSDocThrowsTag}: a `@throws` JSDoc tag.
+ *
+ * The `tagName` is the identifier after the `@`, such as `throws`. The
+ * `typeExpression` supplies the brace-wrapped thrown type, and `comment` is the
+ * trailing description.
+ *
+ * With a tag name of `throws`, an `{Error}` type expression, and an `on
+ * failure` comment, the printer emits:
+ *
+ * ```ts
+ * @throws {Error} on failure
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name.
+ * @param typeExpression The type expression, if any.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocThrowsTag}.
+ */
+export const createJSDocThrowsTag = (
+  tagName: Identifier,
+  typeExpression: JSDocTypeExpression | undefined,
+  comment?: string | readonly JSDocComment[],
+): JSDocThrowsTag =>
+  make("JSDocThrowsTag", {
+    tagName,
+    typeExpression,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocTypeExpression.ts

@@ -0,0 +1,25 @@
+import type { JSDocTypeExpression, TypeNode } from "../../ast";
+import { make } from "../internal/make";
+
+/**
+ * Create a {@link JSDocTypeExpression}: a brace-wrapped JSDoc type.
+ *
+ * The `type` is the wrapped type. The printer surrounds it with curly braces,
+ * producing the `{Type}` form that JSDoc tags use to carry their type.
+ *
+ * With a `number` type, the printer emits:
+ *
+ * ```ts
+ * {number}
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param type The wrapped type.
+ * @returns The created {@link JSDocTypeExpression}.
+ */
+export const createJSDocTypeExpression = (
+  type: TypeNode,
+): JSDocTypeExpression =>
+  make("JSDocTypeExpression", {
+    type,
+  });

package/src/factory/jsdoc/createJSDocTypeLiteral.ts

@@ -0,0 +1,31 @@
+import type { JSDocPropertyTag, JSDocTypeLiteral } from "../../ast";
+import { make } from "../internal/make";
+
+/**
+ * Create a {@link JSDocTypeLiteral}: an object-shape type built from `@prop`
+ * tags.
+ *
+ * The `jsDocPropertyTags` are the member property tags, which the printer emits
+ * one per line. The `isArrayType` flag, when `true`, appends `[]` to mark the
+ * literal as an array of that shape.
+ *
+ * With a single `@prop {number} x` member tag and `isArrayType` of `false`, the
+ * printer emits:
+ *
+ * ```ts
+ * @prop {number} x
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param jsDocPropertyTags The member `@property` tags, if any.
+ * @param isArrayType Whether the literal represents an array of its type.
+ * @returns The created {@link JSDocTypeLiteral}.
+ */
+export const createJSDocTypeLiteral = (
+  jsDocPropertyTags?: readonly JSDocPropertyTag[],
+  isArrayType: boolean = false,
+): JSDocTypeLiteral =>
+  make("JSDocTypeLiteral", {
+    jsDocPropertyTags,
+    isArrayType,
+  });

package/src/factory/jsdoc/createJSDocTypeTag.ts

@@ -0,0 +1,39 @@
+import type {
+  Identifier,
+  JSDocComment,
+  JSDocTypeExpression,
+  JSDocTypeTag,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocTypeTag}: a `@type` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `type` when omitted. The
+ * `typeExpression` supplies the brace-wrapped type, and `comment` is the
+ * trailing description, if any.
+ *
+ * With the default tag name and a `{number}` type expression, the printer
+ * emits:
+ *
+ * ```ts
+ * @type {number}
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `type`.
+ * @param typeExpression The type expression.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocTypeTag}.
+ */
+export const createJSDocTypeTag = (
+  tagName: Identifier | undefined,
+  typeExpression: JSDocTypeExpression,
+  comment?: string | readonly JSDocComment[],
+): JSDocTypeTag =>
+  make("JSDocTypeTag", {
+    tagName: tagName ?? createIdentifier("type"),
+    typeExpression,
+    comment,
+  });

package/src/factory/jsdoc/createJSDocTypedefTag.ts

@@ -0,0 +1,44 @@
+import type {
+  Identifier,
+  JSDocComment,
+  JSDocTypeExpression,
+  JSDocTypeLiteral,
+  JSDocTypedefTag,
+} from "../../ast";
+import { make } from "../internal/make";
+import { createIdentifier } from "../names/createIdentifier";
+
+/**
+ * Create a {@link JSDocTypedefTag}: a `@typedef` JSDoc tag.
+ *
+ * The `tagName` defaults to an identifier named `typedef` when omitted. The
+ * `typeExpression` is the aliased type, either a brace-wrapped type expression
+ * or a {@link JSDocTypeLiteral}. The `fullName` is the alias name, printed after
+ * the type, and `comment` is the trailing description.
+ *
+ * With the default tag name, a `{number}` type expression, and a `Count` name,
+ * the printer emits:
+ *
+ * ```ts
+ * @typedef {number} Count
+ * ```
+ *
+ * @author Jeongho Nam - https://github.com/samchon
+ * @param tagName The tag name; defaults to `typedef`.
+ * @param typeExpression The aliased type, if any.
+ * @param fullName The full alias name, if any.
+ * @param comment The trailing comment, if any.
+ * @returns The created {@link JSDocTypedefTag}.
+ */
+export const createJSDocTypedefTag = (
+  tagName: Identifier | undefined,
+  typeExpression?: JSDocTypeExpression | JSDocTypeLiteral,
+  fullName?: Identifier,
+  comment?: string | readonly JSDocComment[],
+): JSDocTypedefTag =>
+  make("JSDocTypedefTag", {
+    tagName: tagName ?? createIdentifier("typedef"),
+    typeExpression,
+    fullName,
+    comment,
+  });