encoding-option.js 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950
  1. // Validate `encoding` option
  2. export const validateEncoding = ({encoding}) => {
  3. if (ENCODINGS.has(encoding)) {
  4. return;
  5. }
  6. const correctEncoding = getCorrectEncoding(encoding);
  7. if (correctEncoding !== undefined) {
  8. throw new TypeError(`Invalid option \`encoding: ${serializeEncoding(encoding)}\`.
  9. Please rename it to ${serializeEncoding(correctEncoding)}.`);
  10. }
  11. const correctEncodings = [...ENCODINGS].map(correctEncoding => serializeEncoding(correctEncoding)).join(', ');
  12. throw new TypeError(`Invalid option \`encoding: ${serializeEncoding(encoding)}\`.
  13. Please rename it to one of: ${correctEncodings}.`);
  14. };
  15. const TEXT_ENCODINGS = new Set(['utf8', 'utf16le']);
  16. export const BINARY_ENCODINGS = new Set(['buffer', 'hex', 'base64', 'base64url', 'latin1', 'ascii']);
  17. const ENCODINGS = new Set([...TEXT_ENCODINGS, ...BINARY_ENCODINGS]);
  18. const getCorrectEncoding = encoding => {
  19. if (encoding === null) {
  20. return 'buffer';
  21. }
  22. if (typeof encoding !== 'string') {
  23. return;
  24. }
  25. const lowerEncoding = encoding.toLowerCase();
  26. if (lowerEncoding in ENCODING_ALIASES) {
  27. return ENCODING_ALIASES[lowerEncoding];
  28. }
  29. if (ENCODINGS.has(lowerEncoding)) {
  30. return lowerEncoding;
  31. }
  32. };
  33. const ENCODING_ALIASES = {
  34. // eslint-disable-next-line unicorn/text-encoding-identifier-case
  35. 'utf-8': 'utf8',
  36. 'utf-16le': 'utf16le',
  37. 'ucs-2': 'utf16le',
  38. ucs2: 'utf16le',
  39. binary: 'latin1',
  40. };
  41. const serializeEncoding = encoding => typeof encoding === 'string' ? `"${encoding}"` : String(encoding);