deno.land / std@0.224.0 / fs / ensure_file.ts

ensure_file.ts
View Documentation
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
// Copyright 2018-2024 the Deno authors. All rights reserved. MIT license.import { dirname } from "../path/dirname.ts";import { ensureDir, ensureDirSync } from "./ensure_dir.ts";import { getFileInfoType } from "./_get_file_info_type.ts";import { toPathString } from "./_to_path_string.ts";
/** * Asynchronously ensures that the file exists. If the file that is requested to * be created is in directories that do not exist, these directories are created. * If the file already exists, it is not modified. * * Requires the `--allow-read` and `--allow-write` flag. * * @param filePath The path of the file to ensure, as a string or URL. * @returns A void promise that resolves once the file exists. * * @example * ```ts * import { ensureFile } from "https://deno.land/std@$STD_VERSION/fs/ensure_file.ts"; * * await ensureFile("./folder/targetFile.dat"); * ``` */export async function ensureFile(filePath: string | URL): Promise<void> { try { // if file exists const stat = await Deno.lstat(filePath); if (!stat.isFile) { throw new Error( `Ensure path exists, expected 'file', got '${getFileInfoType(stat)}'`, ); } } catch (err) { // if file not exists if (err instanceof Deno.errors.NotFound) { // ensure dir exists await ensureDir(dirname(toPathString(filePath))); // create file await Deno.writeFile(filePath, new Uint8Array()); return; }
throw err; }}
/** * Synchronously ensures that the file exists. If the file that is requested to * be created is in directories that do not exist, these directories are created. * If the file already exists, it is not modified. * * Requires the `--allow-read` and `--allow-write` flag. * * @param filePath The path of the file to ensure, as a string or URL. * @returns A void value that returns once the file exists. * * @example * ```ts * import { ensureFileSync } from "https://deno.land/std@$STD_VERSION/fs/ensure_file.ts"; * * ensureFileSync("./folder/targetFile.dat"); * ``` */export function ensureFileSync(filePath: string | URL): void { try { // if file exists const stat = Deno.lstatSync(filePath); if (!stat.isFile) { throw new Error( `Ensure path exists, expected 'file', got '${getFileInfoType(stat)}'`, ); } } catch (err) { // if file not exists if (err instanceof Deno.errors.NotFound) { // ensure dir exists ensureDirSync(dirname(toPathString(filePath))); // create file Deno.writeFileSync(filePath, new Uint8Array()); return; } throw err; }}
std

Version Info

Tagged at
6 months ago