33
33
* It should return the textual representation of the given tree (typically
34
34
* `string`).
35
35
*
36
- * > 👉 **Note**: unified typically compiles by serializing: most compilers
36
+ * > **Note**: unified typically compiles by serializing: most compilers
37
37
* > return `string` (or `Uint8Array`).
38
38
* > Some compilers, such as the one configured with
39
39
* > [`rehype-react`][rehype-react], return other values (in this case, a
132
132
* In practice, they are functions that can receive options and configure the
133
133
* processor (`this`).
134
134
*
135
- * > 👉 **Note**: plugins are called when the processor is *frozen*, not when
135
+ * > **Note**: plugins are called when the processor is *frozen*, not when
136
136
* > they are applied.
137
137
*/
138
138
246
246
* The run phase is handled by [`trough`][trough], see its documentation for
247
247
* the exact semantics of these functions.
248
248
*
249
- * > 👉 **Note**: you should likely ignore `next`: don’t accept it.
249
+ * > **Note**: you should likely ignore `next`: don’t accept it.
250
250
* > it supports callback-style async work.
251
251
* > But promises are likely easier to reason about.
252
252
*
@@ -521,10 +521,10 @@ export class Processor extends CallableInstance {
521
521
* For example, a list of HTML elements that are self-closing, which is
522
522
* needed during all phases.
523
523
*
524
- * > 👉 **Note**: setting information cannot occur on *frozen* processors.
524
+ * > **Note**: setting information cannot occur on *frozen* processors.
525
525
* > Call the processor first to create a new unfrozen processor.
526
526
*
527
- * > 👉 **Note**: to register custom data in TypeScript, augment the
527
+ * > **Note**: to register custom data in TypeScript, augment the
528
528
* > {@link Data `Data`} interface.
529
529
*
530
530
* @example
@@ -649,9 +649,9 @@ export class Processor extends CallableInstance {
649
649
/**
650
650
* Parse text to a syntax tree.
651
651
*
652
- * > 👉 **Note**: `parse` freezes the processor if not already *frozen*.
652
+ * > **Note**: `parse` freezes the processor if not already *frozen*.
653
653
*
654
- * > 👉 **Note**: `parse` performs the parse phase, not the run phase or other
654
+ * > **Note**: `parse` performs the parse phase, not the run phase or other
655
655
* > phases.
656
656
*
657
657
* @param {Compatible | undefined } [file]
@@ -671,9 +671,9 @@ export class Processor extends CallableInstance {
671
671
/**
672
672
* Process the given file as configured on the processor.
673
673
*
674
- * > 👉 **Note**: `process` freezes the processor if not already *frozen*.
674
+ * > **Note**: `process` freezes the processor if not already *frozen*.
675
675
*
676
- * > 👉 **Note**: `process` performs the parse, run, and stringify phases.
676
+ * > **Note**: `process` performs the parse, run, and stringify phases.
677
677
*
678
678
* @overload
679
679
* @param {Compatible | undefined } file
@@ -697,7 +697,7 @@ export class Processor extends CallableInstance {
697
697
* The parsed, transformed, and compiled value is available at
698
698
* `file.value` (see note).
699
699
*
700
- * > 👉 **Note**: unified typically compiles by serializing: most
700
+ * > **Note**: unified typically compiles by serializing: most
701
701
* > compilers return `string` (or `Uint8Array`).
702
702
* > Some compilers, such as the one configured with
703
703
* > [`rehype-react`][rehype-react], return other values (in this case, a
@@ -780,9 +780,9 @@ export class Processor extends CallableInstance {
780
780
*
781
781
* An error is thrown if asynchronous transforms are configured.
782
782
*
783
- * > 👉 **Note**: `processSync` freezes the processor if not already *frozen*.
783
+ * > **Note**: `processSync` freezes the processor if not already *frozen*.
784
784
*
785
- * > 👉 **Note**: `processSync` performs the parse, run, and stringify phases.
785
+ * > **Note**: `processSync` performs the parse, run, and stringify phases.
786
786
*
787
787
* @param {Compatible | undefined } [file]
788
788
* File (optional); typically `string` or `VFile`; any value accepted as
@@ -793,7 +793,7 @@ export class Processor extends CallableInstance {
793
793
* The parsed, transformed, and compiled value is available at
794
794
* `file.value` (see note).
795
795
*
796
- * > 👉 **Note**: unified typically compiles by serializing: most
796
+ * > **Note**: unified typically compiles by serializing: most
797
797
* > compilers return `string` (or `Uint8Array`).
798
798
* > Some compilers, such as the one configured with
799
799
* > [`rehype-react`][rehype-react], return other values (in this case, a
@@ -835,9 +835,9 @@ export class Processor extends CallableInstance {
835
835
/**
836
836
* Run *transformers* on a syntax tree.
837
837
*
838
- * > 👉 **Note**: `run` freezes the processor if not already *frozen*.
838
+ * > **Note**: `run` freezes the processor if not already *frozen*.
839
839
*
840
- * > 👉 **Note**: `run` performs the run phase, not other phases.
840
+ * > **Note**: `run` performs the run phase, not other phases.
841
841
*
842
842
* @overload
843
843
* @param {HeadTree extends undefined ? Node : HeadTree } tree
@@ -929,9 +929,9 @@ export class Processor extends CallableInstance {
929
929
*
930
930
* An error is thrown if asynchronous transforms are configured.
931
931
*
932
- * > 👉 **Note**: `runSync` freezes the processor if not already *frozen*.
932
+ * > **Note**: `runSync` freezes the processor if not already *frozen*.
933
933
*
934
- * > 👉 **Note**: `runSync` performs the run phase, not other phases.
934
+ * > **Note**: `runSync` performs the run phase, not other phases.
935
935
*
936
936
* @param {HeadTree extends undefined ? Node : HeadTree } tree
937
937
* Tree to transform and inspect.
@@ -966,9 +966,9 @@ export class Processor extends CallableInstance {
966
966
/**
967
967
* Compile a syntax tree.
968
968
*
969
- * > 👉 **Note**: `stringify` freezes the processor if not already *frozen*.
969
+ * > **Note**: `stringify` freezes the processor if not already *frozen*.
970
970
*
971
- * > 👉 **Note**: `stringify` performs the stringify phase, not the run phase
971
+ * > **Note**: `stringify` performs the stringify phase, not the run phase
972
972
* > or other phases.
973
973
*
974
974
* @param {CompileTree extends undefined ? Node : CompileTree } tree
@@ -979,7 +979,7 @@ export class Processor extends CallableInstance {
979
979
* @returns {CompileResult extends undefined ? Value : CompileResult }
980
980
* Textual representation of the tree (see note).
981
981
*
982
- * > 👉 **Note**: unified typically compiles by serializing: most compilers
982
+ * > **Note**: unified typically compiles by serializing: most compilers
983
983
* > return `string` (or `Uint8Array`).
984
984
* > Some compilers, such as the one configured with
985
985
* > [`rehype-react`][rehype-react], return other values (in this case, a
@@ -1010,7 +1010,7 @@ export class Processor extends CallableInstance {
1010
1010
* configuration is changed based on the options that are passed in.
1011
1011
* In other words, the plugin is not added a second time.
1012
1012
*
1013
- * > 👉 **Note**: `use` cannot be called on *frozen* processors.
1013
+ * > **Note**: `use` cannot be called on *frozen* processors.
1014
1014
* > Call the processor first to create a new unfrozen processor.
1015
1015
*
1016
1016
* @example
0 commit comments