index.d.ts 2.8 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182
  1. /**
  2. * Compile markdown to HTML.
  3. *
  4. * > Note: which encodings are supported depends on the engine.
  5. * > For info on Node.js, see:
  6. * > <https://nodejs.org/api/util.html#whatwg-supported-encodings>.
  7. *
  8. * @overload
  9. * @param {Value} value
  10. * Markdown to parse (`string` or `Uint8Array`).
  11. * @param {Encoding | null | undefined} encoding
  12. * Character encoding to understand `value` as when it’s a `Uint8Array`
  13. * (`string`, default: `'utf8'`).
  14. * @param {Options | null | undefined} [options]
  15. * Configuration.
  16. * @returns {string}
  17. * Compiled HTML.
  18. *
  19. * @overload
  20. * @param {Value} value
  21. * Markdown to parse (`string` or `Uint8Array`).
  22. * @param {Options | null | undefined} [options]
  23. * Configuration.
  24. * @returns {string}
  25. * Compiled HTML.
  26. *
  27. * @param {Value} value
  28. * Markdown to parse (`string` or `Uint8Array`).
  29. * @param {Encoding | Options | null | undefined} [encoding]
  30. * Character encoding to understand `value` as when it’s a `Uint8Array`
  31. * (`string`, default: `'utf8'`).
  32. * @param {Options | null | undefined} [options]
  33. * Configuration.
  34. * @returns {string}
  35. * Compiled HTML.
  36. */
  37. export function micromark(value: Value, encoding: Encoding | null | undefined, options?: Options | null | undefined): string;
  38. /**
  39. * Compile markdown to HTML.
  40. *
  41. * > Note: which encodings are supported depends on the engine.
  42. * > For info on Node.js, see:
  43. * > <https://nodejs.org/api/util.html#whatwg-supported-encodings>.
  44. *
  45. * @overload
  46. * @param {Value} value
  47. * Markdown to parse (`string` or `Uint8Array`).
  48. * @param {Encoding | null | undefined} encoding
  49. * Character encoding to understand `value` as when it’s a `Uint8Array`
  50. * (`string`, default: `'utf8'`).
  51. * @param {Options | null | undefined} [options]
  52. * Configuration.
  53. * @returns {string}
  54. * Compiled HTML.
  55. *
  56. * @overload
  57. * @param {Value} value
  58. * Markdown to parse (`string` or `Uint8Array`).
  59. * @param {Options | null | undefined} [options]
  60. * Configuration.
  61. * @returns {string}
  62. * Compiled HTML.
  63. *
  64. * @param {Value} value
  65. * Markdown to parse (`string` or `Uint8Array`).
  66. * @param {Encoding | Options | null | undefined} [encoding]
  67. * Character encoding to understand `value` as when it’s a `Uint8Array`
  68. * (`string`, default: `'utf8'`).
  69. * @param {Options | null | undefined} [options]
  70. * Configuration.
  71. * @returns {string}
  72. * Compiled HTML.
  73. */
  74. export function micromark(value: Value, options?: Options | null | undefined): string;
  75. export { compile } from "./lib/compile.js";
  76. export { parse } from "./lib/parse.js";
  77. export { postprocess } from "./lib/postprocess.js";
  78. export { preprocess } from "./lib/preprocess.js";
  79. export type Options = import("micromark-util-types").Options;
  80. import type { Value } from 'micromark-util-types';
  81. import type { Encoding } from 'micromark-util-types';
  82. //# sourceMappingURL=index.d.ts.map