@isdk/mdast-plus 0.1.2 → 0.2.0

package/docs/classes/MdastBasePipeline.md

@@ -0,0 +1,416 @@
+[**@isdk/mdast-plus**](../README.md)
+
+***
+
+[@isdk/mdast-plus](../globals.md) / MdastBasePipeline
+
+# Class: MdastBasePipeline
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:26](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L26)
+
+Base implementation of the fluent mdast processing pipeline.
+Manages the plugin registry and the execution queue.
+
+## Extended by
+
+- [`MdastPipeline`](MdastPipeline.md)
+
+## Constructors
+
+### Constructor
+
+> **new MdastBasePipeline**(`input`): `MdastBasePipeline`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:54](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L54)
+
+Initializes a new pipeline instance with the given input.
+
+#### Parameters
+
+##### input
+
+`Compatible`
+
+Content to process (string, Buffer, VFile, or AST Node).
+
+#### Returns
+
+`MdastBasePipeline`
+
+## Properties
+
+### \_data
+
+> `protected` **\_data**: `Record`\<`string`, `any`\> = `{}`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:48](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L48)
+
+***
+
+### input
+
+> `protected` **input**: `Compatible`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:46](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L46)
+
+***
+
+### queue
+
+> `protected` **queue**: [`MdastPlugin`](../interfaces/MdastPlugin.md)[] = `[]`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:47](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L47)
+
+## Methods
+
+### assembleProcessor()
+
+> `protected` **assembleProcessor**(`queue`): `Processor`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:326](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L326)
+
+Assembles a unified processor based on the sorted plugin queue.
+
+#### Parameters
+
+##### queue
+
+[`MdastPlugin`](../interfaces/MdastPlugin.md)[]
+
+#### Returns
+
+`Processor`
+
+***
+
+### data()
+
+> **data**(`key`, `value?`): `this`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:64](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L64)
+
+Configures global data for the pipeline, which will be available to all plugins via this.data().
+
+#### Parameters
+
+##### key
+
+Data key or a record of multiple data entries.
+
+`string` | `Record`\<`string`, `any`\>
+
+##### value?
+
+`any`
+
+Value to set (if key is a string).
+
+#### Returns
+
+`this`
+
+The pipeline instance for chaining.
+
+***
+
+### ensureInputPlugins()
+
+> `protected` **ensureInputPlugins**(`queue`, `overrides?`, `maxStage?`): `void`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:149](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L149)
+
+Ensures that input plugins (parser, normalizers) are present in the queue.
+Adds implicit plugins if no parser is detected.
+
+#### Parameters
+
+##### queue
+
+[`MdastPlugin`](../interfaces/MdastPlugin.md)[]
+
+##### overrides?
+
+`Record`\<`string`, `any`\>
+
+##### maxStage?
+
+[`PipelineStage`](../enumerations/PipelineStage.md) = `PipelineStage.stringify`
+
+#### Returns
+
+`void`
+
+***
+
+### from()
+
+> **from**(`fmt`, `overrides?`): `this`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:178](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L178)
+
+Configures the input format and adds its associated plugins to the pipeline.
+
+#### Parameters
+
+##### fmt
+
+Format ID or definition.
+
+`string` | [`MdastFormat`](../interfaces/MdastFormat.md)
+
+##### overrides?
+
+`Record`\<`string`, `any`\>
+
+Optional map to override plugin options by plugin name.
+
+#### Returns
+
+`this`
+
+The pipeline instance for chaining.
+
+***
+
+### getFormat()
+
+> **getFormat**(`id`): `undefined` \| [`MdastFormat`](../interfaces/MdastFormat.md)
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:76](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L76)
+
+Instance-level access to the global format registry.
+
+#### Parameters
+
+##### id
+
+`string`
+
+#### Returns
+
+`undefined` \| [`MdastFormat`](../interfaces/MdastFormat.md)
+
+***
+
+### priority()
+
+> **priority**(`order`): `this`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:314](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L314)
+
+Sets the priority order for the most recently added plugin.
+Plugins with lower order run earlier within the same stage.
+
+#### Parameters
+
+##### order
+
+`number`
+
+Numeric priority.
+
+#### Returns
+
+`this`
+
+The pipeline instance for chaining.
+
+***
+
+### to()
+
+> **to**(`fmt`, `overrides?`): `Promise`\<`VFile`\>
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:198](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L198)
+
+Processes the pipeline and serializes the result into the specified format.
+
+#### Parameters
+
+##### fmt
+
+Target format ID or definition.
+
+`string` | [`MdastFormat`](../interfaces/MdastFormat.md)
+
+##### overrides?
+
+`Record`\<`string`, `any`\>
+
+Optional map to override plugin options.
+
+#### Returns
+
+`Promise`\<`VFile`\>
+
+A promise resolving to a VFile containing the result.
+
+***
+
+### toRuntimeEntry()
+
+> `protected` **toRuntimeEntry**(`entry`, `defaultStage`, `overrides?`): [`MdastPlugin`](../interfaces/MdastPlugin.md) & `object`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:100](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L100)
+
+Normalizes a plugin entry for runtime execution.
+
+#### Parameters
+
+##### entry
+
+[`MdastPlugin`](../interfaces/MdastPlugin.md)
+
+##### defaultStage
+
+[`PipelineStage`](../enumerations/PipelineStage.md)
+
+##### overrides?
+
+`Record`\<`string`, `any`\>
+
+#### Returns
+
+[`MdastPlugin`](../interfaces/MdastPlugin.md) & `object`
+
+***
+
+### use()
+
+> **use**(`plugin`, ...`options`): `this`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:241](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L241)
+
+Adds a plugin or an array of plugins to the pipeline's compile stage.
+
+#### Parameters
+
+##### plugin
+
+The unified plugin function, a MdastPlugin object, or an array of them.
+
+[`MdastPlugin`](../interfaces/MdastPlugin.md) | `Plugin` | ([`MdastPlugin`](../interfaces/MdastPlugin.md) \| `Plugin`)[]
+
+##### options
+
+...`any`[]
+
+Arguments for the plugin(s).
+
+#### Returns
+
+`this`
+
+The pipeline instance for chaining.
+
+***
+
+### useAt()
+
+#### Call Signature
+
+> **useAt**(`stage`, `plugin`, ...`options`): `this`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:252](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L252)
+
+Adds a plugin or an array of plugins to the pipeline at a specific stage.
+
+##### Parameters
+
+###### stage
+
+The stage name or numeric value.
+
+`"parse"` | `"normalize"` | `"compile"` | `"finalize"` | `"stringify"`
+
+###### plugin
+
+The unified plugin function, a MdastPlugin object, or an array of them.
+
+[`MdastPlugin`](../interfaces/MdastPlugin.md) | `Plugin` | ([`MdastPlugin`](../interfaces/MdastPlugin.md) \| `Plugin`)[]
+
+###### options
+
+...`any`[]
+
+Arguments for the plugin(s).
+
+##### Returns
+
+`this`
+
+The pipeline instance for chaining.
+
+#### Call Signature
+
+> **useAt**(`plugin`, ...`options`): `this`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:259](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L259)
+
+Adds a plugin or an array of plugins to the pipeline. The stage is taken from the plugin object(s).
+
+##### Parameters
+
+###### plugin
+
+The MdastPlugin object or an array of them.
+
+[`MdastPlugin`](../interfaces/MdastPlugin.md) | ([`MdastPlugin`](../interfaces/MdastPlugin.md) \| `Plugin`)[]
+
+###### options
+
+...`any`[]
+
+Arguments for the plugin(s) (overrides plugin.options if provided).
+
+##### Returns
+
+`this`
+
+The pipeline instance for chaining.
+
+***
+
+### getFormat()
+
+> `static` **getFormat**(`id`): `undefined` \| [`MdastFormat`](../interfaces/MdastFormat.md)
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:42](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L42)
+
+Retrieves a registered format by its ID.
+
+#### Parameters
+
+##### id
+
+`string`
+
+The format identifier.
+
+#### Returns
+
+`undefined` \| [`MdastFormat`](../interfaces/MdastFormat.md)
+
+The format definition or undefined if not found.
+
+***
+
+### register()
+
+> `static` **register**(`format`): `void`
+
+Defined in: [packages/mdast-plus/src/pipeline.ts:33](https://github.com/isdk/mdast-plus.js/blob/8870eec4ef97dd48bead818813d06479ceff9450/src/pipeline.ts#L33)
+
+Registers a global document format.
+
+#### Parameters
+
+##### format
+
+[`MdastFormat`](../interfaces/MdastFormat.md)
+
+The format definition to register.
+
+#### Returns
+
+`void`