0
0
Fork 0
mirror of https://github.com/denoland/deno.git synced 2024-10-30 09:08:00 -04:00
denoland-deno/ext/node/polyfills/_fs/_fs_opendir.ts
Bartek Iwańczuk b40086fd7d
refactor(core): include_js_files! 'dir' option doesn't change specifiers (#18019)
This commit changes "include_js_files!" macro from "deno_core"
in a way that "dir" option doesn't cause specifiers to be rewritten 
to include it.

Example:
```
include_js_files! {
  dir "js",
  "hello.js",
}
```

The above definition required embedders to use:
`import ... from "internal:<ext_name>/js/hello.js"`. 
But with this change, the "js" directory in which the files are stored
is an implementation detail, which for embedders results in: 
`import ... from "internal:<ext_name>/hello.js"`.

The directory the files are stored in, is an implementation detail and 
in some cases might result in a significant size difference for the 
snapshot. As an example, in "deno_node" extension, we store the 
source code in "polyfills" directory; which resulted in each specifier 
to look like "internal:deno_node/polyfills/<module_name>", but with 
this change it's "internal:deno_node/<module_name>". 

Given that "deno_node" has over 100 files, many of them having 
several import specifiers to the same extension, this change removes
10 characters from each import specifier.
2023-03-05 02:31:38 +00:00

89 lines
2.3 KiB
TypeScript

// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
import Dir from "internal:deno_node/_fs/_fs_dir.ts";
import { Buffer } from "internal:deno_node/buffer.ts";
import {
getOptions,
getValidatedPath,
} from "internal:deno_node/internal/fs/utils.mjs";
import { denoErrorToNodeError } from "internal:deno_node/internal/errors.ts";
import {
validateFunction,
validateInteger,
} from "internal:deno_node/internal/validators.mjs";
import { promisify } from "internal:deno_node/internal/util.mjs";
/** These options aren't funcitonally used right now, as `Dir` doesn't yet support them.
* However, these values are still validated.
*/
type Options = {
encoding?: string;
bufferSize?: number;
};
type Callback = (err?: Error | null, dir?: Dir) => void;
function _validateFunction(callback: unknown): asserts callback is Callback {
validateFunction(callback, "callback");
}
/** @link https://nodejs.org/api/fs.html#fsopendirsyncpath-options */
export function opendir(
path: string | Buffer | URL,
options: Options | Callback,
callback?: Callback,
) {
callback = typeof options === "function" ? options : callback;
_validateFunction(callback);
path = getValidatedPath(path).toString();
let err, dir;
try {
const { bufferSize } = getOptions(options, {
encoding: "utf8",
bufferSize: 32,
});
validateInteger(bufferSize, "options.bufferSize", 1, 4294967295);
/** Throws if path is invalid */
Deno.readDirSync(path);
dir = new Dir(path);
} catch (error) {
err = denoErrorToNodeError(error as Error, { syscall: "opendir" });
}
if (err) {
callback(err);
} else {
callback(null, dir);
}
}
/** @link https://nodejs.org/api/fs.html#fspromisesopendirpath-options */
export const opendirPromise = promisify(opendir) as (
path: string | Buffer | URL,
options?: Options,
) => Promise<Dir>;
export function opendirSync(
path: string | Buffer | URL,
options?: Options,
): Dir {
path = getValidatedPath(path).toString();
const { bufferSize } = getOptions(options, {
encoding: "utf8",
bufferSize: 32,
});
validateInteger(bufferSize, "options.bufferSize", 1, 4294967295);
try {
/** Throws if path is invalid */
Deno.readDirSync(path);
return new Dir(path);
} catch (err) {
throw denoErrorToNodeError(err as Error, { syscall: "opendir" });
}
}