2023-02-14 11:38:45 -05:00
|
|
|
// Copyright 2018-2023 the Deno authors. All rights reserved. MIT license.
|
|
|
|
import {
|
|
|
|
BinaryOptionsArgument,
|
|
|
|
FileOptionsArgument,
|
|
|
|
getEncoding,
|
|
|
|
TextOptionsArgument,
|
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-04 21:31:38 -05:00
|
|
|
} from "internal:deno_node/_fs/_fs_common.ts";
|
|
|
|
import { Buffer } from "internal:deno_node/buffer.ts";
|
|
|
|
import { fromFileUrl } from "internal:deno_node/path.ts";
|
2023-02-14 11:38:45 -05:00
|
|
|
import {
|
|
|
|
BinaryEncodings,
|
|
|
|
Encodings,
|
|
|
|
TextEncodings,
|
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-04 21:31:38 -05:00
|
|
|
} from "internal:deno_node/_utils.ts";
|
|
|
|
import { promisify } from "internal:deno_node/internal/util.mjs";
|
2023-02-14 11:38:45 -05:00
|
|
|
|
|
|
|
function maybeDecode(data: Uint8Array, encoding: TextEncodings): string;
|
|
|
|
function maybeDecode(
|
|
|
|
data: Uint8Array,
|
|
|
|
encoding: BinaryEncodings | null,
|
|
|
|
): Buffer;
|
|
|
|
function maybeDecode(
|
|
|
|
data: Uint8Array,
|
|
|
|
encoding: Encodings | null,
|
|
|
|
): string | Buffer {
|
|
|
|
const buffer = Buffer.from(data.buffer, data.byteOffset, data.byteLength);
|
|
|
|
if (encoding && encoding !== "binary") return buffer.toString(encoding);
|
|
|
|
return buffer;
|
|
|
|
}
|
|
|
|
|
|
|
|
type TextCallback = (err: Error | null, data?: string) => void;
|
|
|
|
type BinaryCallback = (err: Error | null, data?: Buffer) => void;
|
|
|
|
type GenericCallback = (err: Error | null, data?: string | Buffer) => void;
|
|
|
|
type Callback = TextCallback | BinaryCallback | GenericCallback;
|
|
|
|
|
|
|
|
export function readFile(
|
|
|
|
path: string | URL,
|
|
|
|
options: TextOptionsArgument,
|
|
|
|
callback: TextCallback,
|
|
|
|
): void;
|
|
|
|
export function readFile(
|
|
|
|
path: string | URL,
|
|
|
|
options: BinaryOptionsArgument,
|
|
|
|
callback: BinaryCallback,
|
|
|
|
): void;
|
|
|
|
export function readFile(
|
|
|
|
path: string | URL,
|
|
|
|
options: null | undefined | FileOptionsArgument,
|
|
|
|
callback: BinaryCallback,
|
|
|
|
): void;
|
|
|
|
export function readFile(path: string | URL, callback: BinaryCallback): void;
|
|
|
|
export function readFile(
|
|
|
|
path: string | URL,
|
|
|
|
optOrCallback?: FileOptionsArgument | Callback | null | undefined,
|
|
|
|
callback?: Callback,
|
|
|
|
) {
|
|
|
|
path = path instanceof URL ? fromFileUrl(path) : path;
|
|
|
|
let cb: Callback | undefined;
|
|
|
|
if (typeof optOrCallback === "function") {
|
|
|
|
cb = optOrCallback;
|
|
|
|
} else {
|
|
|
|
cb = callback;
|
|
|
|
}
|
|
|
|
|
|
|
|
const encoding = getEncoding(optOrCallback);
|
|
|
|
|
|
|
|
const p = Deno.readFile(path);
|
|
|
|
|
|
|
|
if (cb) {
|
|
|
|
p.then((data: Uint8Array) => {
|
|
|
|
if (encoding && encoding !== "binary") {
|
|
|
|
const text = maybeDecode(data, encoding);
|
|
|
|
return (cb as TextCallback)(null, text);
|
|
|
|
}
|
|
|
|
const buffer = maybeDecode(data, encoding);
|
|
|
|
(cb as BinaryCallback)(null, buffer);
|
|
|
|
}, (err) => cb && cb(err));
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
export const readFilePromise = promisify(readFile) as (
|
|
|
|
& ((path: string | URL, opt: TextOptionsArgument) => Promise<string>)
|
|
|
|
& ((path: string | URL, opt?: BinaryOptionsArgument) => Promise<Buffer>)
|
|
|
|
& ((path: string | URL, opt?: FileOptionsArgument) => Promise<Buffer>)
|
|
|
|
);
|
|
|
|
|
|
|
|
export function readFileSync(
|
|
|
|
path: string | URL,
|
|
|
|
opt: TextOptionsArgument,
|
|
|
|
): string;
|
|
|
|
export function readFileSync(
|
|
|
|
path: string | URL,
|
|
|
|
opt?: BinaryOptionsArgument,
|
|
|
|
): Buffer;
|
|
|
|
export function readFileSync(
|
|
|
|
path: string | URL,
|
|
|
|
opt?: FileOptionsArgument,
|
|
|
|
): string | Buffer {
|
|
|
|
path = path instanceof URL ? fromFileUrl(path) : path;
|
|
|
|
const data = Deno.readFileSync(path);
|
|
|
|
const encoding = getEncoding(opt);
|
|
|
|
if (encoding && encoding !== "binary") {
|
|
|
|
const text = maybeDecode(data, encoding);
|
|
|
|
return text;
|
|
|
|
}
|
|
|
|
const buffer = maybeDecode(data, encoding);
|
|
|
|
return buffer;
|
|
|
|
}
|