Add support for null in API input types

Author: wooorm

lib/index.js

@@ -17,27 +17,27 @@
  *
  * @typedef Schema
  *   Sanitization configuration.
- * @property {Attributes | undefined} [attributes]
+ * @property {Attributes | null | undefined} [attributes]
  *   Map of tag names to allowed properties.
  *
  *   The special `'*'` key defines property names allowed on all elements.
- * @property {Record<string, Record<string, PropertyValue>> | undefined} [required]
+ * @property {Record<string, Record<string, PropertyValue>> | null | undefined} [required]
  *   Map of tag names to required property names and their default property value.
- * @property {Array<string> | undefined} [tagNames]
+ * @property {Array<string> | null | undefined} [tagNames]
  *   List of allowed tag names.
- * @property {Record<string, Array<string>> | undefined} [protocols]
+ * @property {Record<string, Array<string>> | null | undefined} [protocols]
  *   Map of protocols to allow in property values.
- * @property {Record<string, Array<string>> | undefined} [ancestors]
+ * @property {Record<string, Array<string>> | null | undefined} [ancestors]
  *   Map of tag names to their required ancestor elements.
- * @property {Array<string> | undefined} [clobber]
+ * @property {Array<string> | null | undefined} [clobber]
  *   List of allowed property names which can clobber.
- * @property {string | undefined} [clobberPrefix]
+ * @property {string | null | undefined} [clobberPrefix]
  *   Prefix to use before potentially clobbering property names.
- * @property {Array<string> | undefined} [strip]
+ * @property {Array<string> | null | undefined} [strip]
  *   Names of elements to strip from the tree.
- * @property {boolean | undefined} [allowComments]
+ * @property {boolean | null | undefined} [allowComments]
  *   Whether to allow comments.
- * @property {boolean | undefined} [allowDoctypes]
+ * @property {boolean | null | undefined} [allowDoctypes]
  *   Whether to allow doctypes.
  *
  * @typedef {(schema: Schema, value: any, node: any, stack: Array<string>) => unknown} Handler
@@ -69,7 +69,7 @@ const nodeSchema = {
  *
  * @param {Node} node
  *   Hast tree to sanitize
- * @param {Schema} [schema]
+ * @param {Schema | null | undefined} [schema]
  *   Schema defining how to sanitize - defaults to Github style sanitation
  */
 export function sanitize(node, schema) {