index.js 3.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128
  1. 'use strict'
  2. // This is adapted from https://github.com/normalize/mz
  3. // Copyright (c) 2014-2016 Jonathan Ong me@jongleberry.com and Contributors
  4. const u = require('universalify').fromCallback
  5. const fs = require('graceful-fs')
  6. const api = [
  7. 'access',
  8. 'appendFile',
  9. 'chmod',
  10. 'chown',
  11. 'close',
  12. 'copyFile',
  13. 'fchmod',
  14. 'fchown',
  15. 'fdatasync',
  16. 'fstat',
  17. 'fsync',
  18. 'ftruncate',
  19. 'futimes',
  20. 'lchmod',
  21. 'lchown',
  22. 'link',
  23. 'lstat',
  24. 'mkdir',
  25. 'mkdtemp',
  26. 'open',
  27. 'opendir',
  28. 'readdir',
  29. 'readFile',
  30. 'readlink',
  31. 'realpath',
  32. 'rename',
  33. 'rm',
  34. 'rmdir',
  35. 'stat',
  36. 'symlink',
  37. 'truncate',
  38. 'unlink',
  39. 'utimes',
  40. 'writeFile'
  41. ].filter(key => {
  42. // Some commands are not available on some systems. Ex:
  43. // fs.opendir was added in Node.js v12.12.0
  44. // fs.rm was added in Node.js v14.14.0
  45. // fs.lchown is not available on at least some Linux
  46. return typeof fs[key] === 'function'
  47. })
  48. // Export cloned fs:
  49. Object.assign(exports, fs)
  50. // Universalify async methods:
  51. api.forEach(method => {
  52. exports[method] = u(fs[method])
  53. })
  54. // We differ from mz/fs in that we still ship the old, broken, fs.exists()
  55. // since we are a drop-in replacement for the native module
  56. exports.exists = function (filename, callback) {
  57. if (typeof callback === 'function') {
  58. return fs.exists(filename, callback)
  59. }
  60. return new Promise(resolve => {
  61. return fs.exists(filename, resolve)
  62. })
  63. }
  64. // fs.read(), fs.write(), & fs.writev() need special treatment due to multiple callback args
  65. exports.read = function (fd, buffer, offset, length, position, callback) {
  66. if (typeof callback === 'function') {
  67. return fs.read(fd, buffer, offset, length, position, callback)
  68. }
  69. return new Promise((resolve, reject) => {
  70. fs.read(fd, buffer, offset, length, position, (err, bytesRead, buffer) => {
  71. if (err) return reject(err)
  72. resolve({ bytesRead, buffer })
  73. })
  74. })
  75. }
  76. // Function signature can be
  77. // fs.write(fd, buffer[, offset[, length[, position]]], callback)
  78. // OR
  79. // fs.write(fd, string[, position[, encoding]], callback)
  80. // We need to handle both cases, so we use ...args
  81. exports.write = function (fd, buffer, ...args) {
  82. if (typeof args[args.length - 1] === 'function') {
  83. return fs.write(fd, buffer, ...args)
  84. }
  85. return new Promise((resolve, reject) => {
  86. fs.write(fd, buffer, ...args, (err, bytesWritten, buffer) => {
  87. if (err) return reject(err)
  88. resolve({ bytesWritten, buffer })
  89. })
  90. })
  91. }
  92. // fs.writev only available in Node v12.9.0+
  93. if (typeof fs.writev === 'function') {
  94. // Function signature is
  95. // s.writev(fd, buffers[, position], callback)
  96. // We need to handle the optional arg, so we use ...args
  97. exports.writev = function (fd, buffers, ...args) {
  98. if (typeof args[args.length - 1] === 'function') {
  99. return fs.writev(fd, buffers, ...args)
  100. }
  101. return new Promise((resolve, reject) => {
  102. fs.writev(fd, buffers, ...args, (err, bytesWritten, buffers) => {
  103. if (err) return reject(err)
  104. resolve({ bytesWritten, buffers })
  105. })
  106. })
  107. }
  108. }
  109. // fs.realpath.native sometimes not available if fs is monkey-patched
  110. if (typeof fs.realpath.native === 'function') {
  111. exports.realpath.native = u(fs.realpath.native)
  112. } else {
  113. process.emitWarning(
  114. 'fs.realpath.native is not a function. Is fs being monkey-patched?',
  115. 'Warning', 'fs-extra-WARN0003'
  116. )
  117. }