Processor

Extends

• CallableInstance<[], Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>>

Type Parameters

Processor(…parameters): Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Parameters

Returns

Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Defined in

node_modules/unified/lib/index.d.ts:15

Constructors

new Processor()

new Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>(): Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Create a processor.

Returns

Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Overrides

CallableInstance<[], Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>>.constructor

Defined in

node_modules/unified/lib/index.d.ts:19

Properties

attachers

attachers: [Plugin<unknown[], undefined, undefined>, ...parameters: unknown[]][]

Internal list of configured plugins.

Deprecated

This is a private internal property and should not be used.

Defined in

node_modules/unified/lib/index.d.ts:52

compiler

compiler: undefined | Compiler<CompileTree extends undefined ? Node : CompileTree, CompileResult extends undefined ? CompileResults : CompileResult>

Compiler to use.

Defined in

node_modules/unified/lib/index.d.ts:64

Compiler

Compiler: undefined | Compiler<CompileTree extends undefined ? Node : CompileTree, CompileResult extends undefined ? CompileResults : CompileResult>

Compiler to use (deprecated).

Deprecated

Use compiler instead.

Defined in

node_modules/unified/lib/index.d.ts:33

freezeIndex

freezeIndex: number

Internal state to track where we are while freezing.

Deprecated

This is a private internal property and should not be used.

Defined in

node_modules/unified/lib/index.d.ts:72

frozen

frozen: undefined | boolean

Internal state to track whether we’re frozen.

Deprecated

This is a private internal property and should not be used.

Defined in

node_modules/unified/lib/index.d.ts:80

namespace

namespace: Data

Internal state.

Deprecated

This is a private internal property and should not be used.

Defined in

node_modules/unified/lib/index.d.ts:88

parser

parser: undefined | Parser<ParseTree extends undefined ? Node : ParseTree>

Parser to use.

Defined in

node_modules/unified/lib/index.d.ts:97

Parser

Parser: undefined | Parser<ParseTree extends undefined ? Node : ParseTree>

Parser to use (deprecated).

Deprecated

Use parser instead.

Defined in

node_modules/unified/lib/index.d.ts:44

transformers

transformers: Pipeline

Internal list of configured transformers.

Deprecated

This is a private internal property and should not be used.

Defined in

node_modules/unified/lib/index.d.ts:105

Methods

copy()

copy(): Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Copy a processor.

Returns

Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

New unfrozen processor (Processor) that is configured to work the same as its ancestor. When the descendant processor is configured in the future it does not affect the ancestral processor.

Deprecated

This is a private internal method and should not be used.

Defined in

node_modules/unified/lib/index.d.ts:117

data()

data()

data<Key>(): Data

Configure the processor with info available to all plugins. Information is stored in an object.

Typically, options can be given to a specific plugin, but sometimes it makes sense to have information shared with several plugins. For example, a list of HTML elements that are self-closing, which is needed during all phases.

Note: setting information cannot occur on frozen processors. Call the processor first to create a new unfrozen processor.

Note: to register custom data in TypeScript, augment the Data interface.

Type Parameters

Returns

Data

The current processor when setting, the value at key when getting, or the entire dataset when getting without key.

Example

This example show how to get and set info:

import {unified} from 'unified'

const processor = unified().data('alpha', 'bravo')

processor.data('alpha') // => 'bravo'

processor.data() // => {alpha: 'bravo'}

processor.data({charlie: 'delta'})

processor.data() // => {charlie: 'delta'}

Defined in

node_modules/unified/lib/index.d.ts:177

data(dataset)

data<Key>(dataset): Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Configure the processor with info available to all plugins. Information is stored in an object.

Typically, options can be given to a specific plugin, but sometimes it makes sense to have information shared with several plugins. For example, a list of HTML elements that are self-closing, which is needed during all phases.

Note: setting information cannot occur on frozen processors. Call the processor first to create a new unfrozen processor.

Note: to register custom data in TypeScript, augment the Data interface.

Type Parameters

Parameters

Returns

Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

The current processor when setting, the value at key when getting, or the entire dataset when getting without key.

Example

This example show how to get and set info:

import {unified} from 'unified'

const processor = unified().data('alpha', 'bravo')

processor.data('alpha') // => 'bravo'

processor.data() // => {alpha: 'bravo'}

processor.data({charlie: 'delta'})

processor.data() // => {charlie: 'delta'}

Defined in

node_modules/unified/lib/index.d.ts:237

data(key)

data<Key>(key?): Data[Key]

Configure the processor with info available to all plugins. Information is stored in an object.

Typically, options can be given to a specific plugin, but sometimes it makes sense to have information shared with several plugins. For example, a list of HTML elements that are self-closing, which is needed during all phases.

Note: setting information cannot occur on frozen processors. Call the processor first to create a new unfrozen processor.

Note: to register custom data in TypeScript, augment the Data interface.

Type Parameters

Parameters

Returns

Data[Key]

The current processor when setting, the value at key when getting, or the entire dataset when getting without key.

Example

This example show how to get and set info:

import {unified} from 'unified'

const processor = unified().data('alpha', 'bravo')

processor.data('alpha') // => 'bravo'

processor.data() // => {alpha: 'bravo'}

processor.data({charlie: 'delta'})

processor.data() // => {charlie: 'delta'}

Defined in

node_modules/unified/lib/index.d.ts:297

data(key, value)

data<Key>(key?, value?): Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Configure the processor with info available to all plugins. Information is stored in an object.

Typically, options can be given to a specific plugin, but sometimes it makes sense to have information shared with several plugins. For example, a list of HTML elements that are self-closing, which is needed during all phases.

Note: setting information cannot occur on frozen processors. Call the processor first to create a new unfrozen processor.

Note: to register custom data in TypeScript, augment the Data interface.

Type Parameters

Parameters

Returns

Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

The current processor when setting, the value at key when getting, or the entire dataset when getting without key.

Example

This example show how to get and set info:

import {unified} from 'unified'

const processor = unified().data('alpha', 'bravo')

processor.data('alpha') // => 'bravo'

processor.data() // => {alpha: 'bravo'}

processor.data({charlie: 'delta'})

processor.data() // => {charlie: 'delta'}

Defined in

node_modules/unified/lib/index.d.ts:357

freeze()

freeze(): Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Freeze a processor.

Frozen processors are meant to be extended and not to be configured directly.

When a processor is frozen it cannot be unfrozen. New processors working the same way can be created by calling the processor.

It’s possible to freeze processors explicitly by calling .freeze(). Processors freeze automatically when .parse(), .run(), .runSync(), .stringify(), .process(), or .processSync() are called.

Returns

Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

The current processor.

Defined in

node_modules/unified/lib/index.d.ts:375

parse()

parse(file?): ParseTree extends undefined ? Node : ParseTree

Parse text to a syntax tree.

Note: parse freezes the processor if not already frozen.

Note: parse performs the parse phase, not the run phase or other phases.

Parameters

Returns

ParseTree extends undefined ? Node : ParseTree

Syntax tree representing file.

Defined in

node_modules/unified/lib/index.d.ts:390

process()

process(file, done)

process(file?, done?): undefined

Process the given file as configured on the processor.

Note: process freezes the processor if not already frozen.

Note: process performs the parse, run, and stringify phases.

Parameters

Returns

undefined

Nothing if done is given. Otherwise a promise, rejected with a fatal error or resolved with the processed file.

The parsed, transformed, and compiled value is available at file.value (see note).

Note: unified typically compiles by serializing: most compilers return string (or Uint8Array). Some compilers, such as the one configured with rehype-react, return other values (in this case, a React tree). If you’re using a compiler that doesn’t serialize, expect different result values.

To register custom results in TypeScript, add them to CompileResultMap.

Defined in

node_modules/unified/lib/index.d.ts:433

process(file)

process(file?): Promise<VFileWithOutput<CompileResult>>

Process the given file as configured on the processor.

Note: process freezes the processor if not already frozen.

Note: process performs the parse, run, and stringify phases.

Parameters

Returns

Promise<VFileWithOutput<CompileResult>>

Nothing if done is given. Otherwise a promise, rejected with a fatal error or resolved with the processed file.

The parsed, transformed, and compiled value is available at file.value (see note).

Note: unified typically compiles by serializing: most compilers return string (or Uint8Array). Some compilers, such as the one configured with rehype-react, return other values (in this case, a React tree). If you’re using a compiler that doesn’t serialize, expect different result values.

To register custom results in TypeScript, add them to CompileResultMap.

Defined in

node_modules/unified/lib/index.d.ts:476

processSync()

processSync(file?): VFileWithOutput<CompileResult>

Process the given file as configured on the processor.

An error is thrown if asynchronous transforms are configured.

Note: processSync freezes the processor if not already frozen.

Note: processSync performs the parse, run, and stringify phases.

Parameters

Returns

VFileWithOutput<CompileResult>

The processed file.

The parsed, transformed, and compiled value is available at file.value (see note).

Note: unified typically compiles by serializing: most compilers return string (or Uint8Array). Some compilers, such as the one configured with rehype-react, return other values (in this case, a React tree). If you’re using a compiler that doesn’t serialize, expect different result values.

To register custom results in TypeScript, add them to CompileResultMap.

Defined in

node_modules/unified/lib/index.d.ts:508

run()

run(tree, done)

run(tree, done?): undefined

Run transformers on a syntax tree.

Note: run freezes the processor if not already frozen.

Note: run performs the run phase, not other phases.

Parameters

Returns

undefined

Nothing if done is given. Otherwise, a promise rejected with a fatal error or resolved with the transformed tree.

Defined in

node_modules/unified/lib/index.d.ts:547

run(tree, file, done)

run(tree, file?, done?): undefined

Run transformers on a syntax tree.

Note: run freezes the processor if not already frozen.

Note: run performs the run phase, not other phases.

Parameters

Returns

undefined

Nothing if done is given. Otherwise, a promise rejected with a fatal error or resolved with the transformed tree.

Defined in

node_modules/unified/lib/index.d.ts:586

run(tree, file)

run(tree, file?): Promise<TailTree extends undefined ? Node : TailTree>

Run transformers on a syntax tree.

Note: run freezes the processor if not already frozen.

Note: run performs the run phase, not other phases.

Parameters

Returns

Promise<TailTree extends undefined ? Node : TailTree>

Nothing if done is given. Otherwise, a promise rejected with a fatal error or resolved with the transformed tree.

Defined in

node_modules/unified/lib/index.d.ts:625

runSync()

runSync(tree, file?): TailTree extends undefined ? Node : TailTree

Run transformers on a syntax tree.

An error is thrown if asynchronous transforms are configured.

Note: runSync freezes the processor if not already frozen.

Note: runSync performs the run phase, not other phases.

Parameters

Returns

TailTree extends undefined ? Node : TailTree

Transformed tree.

Defined in

node_modules/unified/lib/index.d.ts:643

stringify()

stringify(tree, file?): CompileResult extends undefined ? Value : CompileResult

Compile a syntax tree.

Note: stringify freezes the processor if not already frozen.

Note: stringify performs the stringify phase, not the run phase or other phases.

Parameters

Returns

CompileResult extends undefined ? Value : CompileResult

Textual representation of the tree (see note).

Note: unified typically compiles by serializing: most compilers return string (or Uint8Array). Some compilers, such as the one configured with rehype-react, return other values (in this case, a React tree). If you’re using a compiler that doesn’t serialize, expect different result values.

To register custom results in TypeScript, add them to CompileResultMap.

Defined in

node_modules/unified/lib/index.d.ts:673

use()

use(preset)

use<Parameters_1, Input, Output>(preset?): Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Configure the processor to use a plugin, a list of usable values, or a preset.

If the processor is already using a plugin, the previous plugin configuration is changed based on the options that are passed in. In other words, the plugin is not added a second time.

Note: use cannot be called on frozen processors. Call the processor first to create a new unfrozen processor.

Type Parameters

Parameters

Returns

Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Current processor.

Example

There are many ways to pass plugins to .use(). This example gives an overview:

import {unified} from 'unified'

unified()
  // Plugin with options:
  .use(pluginA, {x: true, y: true})
  // Passing the same plugin again merges configuration (to `{x: true, y: false, z: true}`):
  .use(pluginA, {y: false, z: true})
  // Plugins:
  .use([pluginB, pluginC])
  // Two plugins, the second with options:
  .use([pluginD, [pluginE, {}]])
  // Preset with plugins and settings:
  .use({plugins: [pluginF, [pluginG, {}]], settings: {position: false}})
  // Settings only:
  .use({settings: {position: false}})

Defined in

node_modules/unified/lib/index.d.ts:731

use(list)

use<Parameters_1, Input, Output>(list): Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Configure the processor to use a plugin, a list of usable values, or a preset.

If the processor is already using a plugin, the previous plugin configuration is changed based on the options that are passed in. In other words, the plugin is not added a second time.

Note: use cannot be called on frozen processors. Call the processor first to create a new unfrozen processor.

Type Parameters

Parameters

Returns

Processor<ParseTree, HeadTree, TailTree, CompileTree, CompileResult>

Current processor.

Example

There are many ways to pass plugins to .use(). This example gives an overview:

import {unified} from 'unified'

unified()
  // Plugin with options:
  .use(pluginA, {x: true, y: true})
  // Passing the same plugin again merges configuration (to `{x: true, y: false, z: true}`):
  .use(pluginA, {y: false, z: true})
  // Plugins:
  .use([pluginB, pluginC])
  // Two plugins, the second with options:
  .use([pluginD, [pluginE, {}]])
  // Preset with plugins and settings:
  .use({plugins: [pluginF, [pluginG, {}]], settings: {position: false}})
  // Settings only:
  .use({settings: {position: false}})

Defined in

node_modules/unified/lib/index.d.ts:789

use(plugin, parameters)

use<Parameters_1, Input, Output>(plugin, …parameters): UsePlugin<ParseTree, HeadTree, TailTree, CompileTree, CompileResult, Input, Output>

Configure the processor to use a plugin, a list of usable values, or a preset.

If the processor is already using a plugin, the previous plugin configuration is changed based on the options that are passed in. In other words, the plugin is not added a second time.

Note: use cannot be called on frozen processors. Call the processor first to create a new unfrozen processor.

Type Parameters

Parameters

Returns

UsePlugin<ParseTree, HeadTree, TailTree, CompileTree, CompileResult, Input, Output>

Current processor.

Example

There are many ways to pass plugins to .use(). This example gives an overview:

import {unified} from 'unified'

unified()
  // Plugin with options:
  .use(pluginA, {x: true, y: true})
  // Passing the same plugin again merges configuration (to `{x: true, y: false, z: true}`):
  .use(pluginA, {y: false, z: true})
  // Plugins:
  .use([pluginB, pluginC])
  // Two plugins, the second with options:
  .use([pluginD, [pluginE, {}]])
  // Preset with plugins and settings:
  .use({plugins: [pluginF, [pluginG, {}]], settings: {position: false}})
  // Settings only:
  .use({settings: {position: false}})

Defined in

node_modules/unified/lib/index.d.ts:847