@ox-content/napi 2.33.0 → 2.35.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (2) hide show
  1. package/index.d.ts +17 -2
  2. package/package.json +6 -6
package/index.d.ts CHANGED
@@ -58,7 +58,7 @@ export declare function externalizeSsgAssets(pages: Array<JsSsgGeneratedHtmlPage
58
58
  export declare function extractCodeBlocks(source: string): Array<JsCodeBlock>
59
59
 
60
60
  /** Extracts normalized documentation entries from source directories using Oxc. */
61
- export declare function extractDocsFromDirectories(srcDirs: Array<string>, include: Array<string>, exclude: Array<string>, includePrivate?: boolean | undefined | null, includeInternal?: boolean | undefined | null): Array<JsExtractedDocsModule>
61
+ export declare function extractDocsFromDirectories(srcDirs: Array<string>, include: Array<string>, exclude: Array<string>, includePrivate?: boolean | undefined | null, includeInternal?: boolean | undefined | null, typeParameters?: boolean | undefined | null): Array<JsExtractedDocsModule>
62
62
 
63
63
  /** Extracts generated API docs grouped by public entry points. */
64
64
  export declare function extractDocsFromEntryPoints(entryPoints: Array<JsEntryPointSpec>, options?: JsEntryPointDocsOptions | undefined | null): Array<JsEntrypointDocsModule>
@@ -67,7 +67,7 @@ export declare function extractDocsFromEntryPoints(entryPoints: Array<JsEntryPoi
67
67
  export declare function extractDocsTests(source: string, options?: JsDocsTestOptions | undefined | null): Array<JsCodeBlock>
68
68
 
69
69
  /** Extracts normalized documentation entries from a JavaScript/TypeScript file using Oxc. */
70
- export declare function extractFileDocEntries(filePath: string, includePrivate?: boolean | undefined | null, includeInternal?: boolean | undefined | null): Array<JsDocEntry>
70
+ export declare function extractFileDocEntries(filePath: string, includePrivate?: boolean | undefined | null, includeInternal?: boolean | undefined | null, typeParameters?: boolean | undefined | null): Array<JsDocEntry>
71
71
 
72
72
  /** Extracts documented declarations from a JavaScript/TypeScript file using Oxc. */
73
73
  export declare function extractFileDocs(filePath: string, includePrivate?: boolean | undefined | null, includeInternal?: boolean | undefined | null): Array<JsSourceDocItem>
@@ -261,6 +261,7 @@ export interface JsDocEntry {
261
261
  endLine: number
262
262
  signature?: string
263
263
  members?: Array<JsDocMember>
264
+ typeParameters?: Array<JsTypeParam>
264
265
  }
265
266
 
266
267
  /** Normalized member documentation used by generated API docs. */
@@ -321,6 +322,7 @@ export interface JsDocsMarkdownEntry {
321
322
  endLine: number
322
323
  signature?: string
323
324
  members?: Array<JsDocMember>
325
+ typeParameters?: Array<JsTypeParam>
324
326
  }
325
327
 
326
328
  /** Extracted docs for one source file used by generated API Markdown. */
@@ -429,6 +431,11 @@ export interface JsEntryPointDocsOptions {
429
431
  internal?: boolean
430
432
  externalDocs?: boolean
431
433
  externalPackageSources?: Array<JsExternalPackageSource>
434
+ /**
435
+ * Opt in to TSDoc-style type-parameter docs (`@typeParam` / `<T>` table).
436
+ * Off by default.
437
+ */
438
+ typeParameters?: boolean
432
439
  }
433
440
 
434
441
  /** Public entry point module. */
@@ -1185,6 +1192,14 @@ export interface JsTransformOptions {
1185
1192
  editThisPage?: JsEditThisPageOptions
1186
1193
  }
1187
1194
 
1195
+ /** Type parameter documentation (`<T extends C = D>`) used by generated API docs. */
1196
+ export interface JsTypeParam {
1197
+ name: string
1198
+ constraint?: string
1199
+ default?: string
1200
+ description: string
1201
+ }
1202
+
1188
1203
  /** Wiki-link transform options. */
1189
1204
  export interface JsWikiLinkOptions {
1190
1205
  /** Enable `[[target]]` and `[[target|label]]` expansion. */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@ox-content/napi",
3
- "version": "2.33.0",
3
+ "version": "2.35.0",
4
4
  "description": "Node.js bindings for Ox Content - High-performance Markdown parser",
5
5
  "keywords": [
6
6
  "markdown",
@@ -45,10 +45,10 @@
45
45
  ]
46
46
  },
47
47
  "optionalDependencies": {
48
- "@ox-content/binding-darwin-x64": "2.33.0",
49
- "@ox-content/binding-darwin-arm64": "2.33.0",
50
- "@ox-content/binding-linux-x64-gnu": "2.33.0",
51
- "@ox-content/binding-linux-arm64-gnu": "2.33.0",
52
- "@ox-content/binding-win32-x64-msvc": "2.33.0"
48
+ "@ox-content/binding-darwin-x64": "2.35.0",
49
+ "@ox-content/binding-darwin-arm64": "2.35.0",
50
+ "@ox-content/binding-linux-x64-gnu": "2.35.0",
51
+ "@ox-content/binding-linux-arm64-gnu": "2.35.0",
52
+ "@ox-content/binding-win32-x64-msvc": "2.35.0"
53
53
  }
54
54
  }