blank project

node_modules/mdast-util-to-markdown/lib/util/safe.d.ts

@@ -0,0 +1,29 @@
+/**
+ * Make a string safe for embedding in markdown constructs.
+ *
+ * In markdown, almost all punctuation characters can, in certain cases,
+ * result in something.
+ * Whether they do is highly subjective to where they happen and in what
+ * they happen.
+ *
+ * To solve this, `mdast-util-to-markdown` tracks:
+ *
+ * * Characters before and after something;
+ * * What “constructs” we are in.
+ *
+ * This information is then used by this function to escape or encode
+ * special characters.
+ *
+ * @param {State} state
+ *   Info passed around about the current state.
+ * @param {string | null | undefined} input
+ *   Raw value to make safe.
+ * @param {SafeConfig} config
+ *   Configuration.
+ * @returns {string}
+ *   Serialized markdown safe for embedding.
+ */
+export function safe(state: State, input: string | null | undefined, config: SafeConfig): string;
+import type { State } from 'mdast-util-to-markdown';
+import type { SafeConfig } from 'mdast-util-to-markdown';
+//# sourceMappingURL=safe.d.ts.map