diff options
Diffstat (limited to 'cli/js/make_temp.ts')
-rw-r--r-- | cli/js/make_temp.ts | 70 |
1 files changed, 50 insertions, 20 deletions
diff --git a/cli/js/make_temp.ts b/cli/js/make_temp.ts index 7b0038388..1d8e283d3 100644 --- a/cli/js/make_temp.ts +++ b/cli/js/make_temp.ts @@ -2,57 +2,87 @@ import { sendSync, sendAsync } from "./dispatch_json.ts"; export interface MakeTempOptions { + /** Directory where the temporary directory should be created (defaults to + * the env variable TMPDIR, or the system's default, usually /tmp). */ dir?: string; + /** String that should precede the random portion of the temporary + * directory's name. */ prefix?: string; + /** String that should follow the random portion of the temporary + * directory's name. */ suffix?: string; } -/** makeTempDirSync is the synchronous version of `makeTempDir`. +/** Synchronously creates a new temporary directory in the directory `dir`, + * its name beginning with `prefix` and ending with `suffix`. + * + * It returns the full path to the newly created directory. + * + * If `dir` is unspecified, uses the default directory for temporary files. + * Multiple programs calling this function simultaneously will create different + * directories. It is the caller's responsibility to remove the directory when + * no longer needed. * * const tempDirName0 = Deno.makeTempDirSync(); * const tempDirName1 = Deno.makeTempDirSync({ prefix: 'my_temp' }); - */ + * + * Requires `allow-write` permission. */ export function makeTempDirSync(options: MakeTempOptions = {}): string { return sendSync("op_make_temp_dir", options); } -/** makeTempDir creates a new temporary directory in the directory `dir`, its - * name beginning with `prefix` and ending with `suffix`. - * It returns the full path to the newly created directory. - * If `dir` is unspecified, tempDir uses the default directory for temporary - * files. Multiple programs calling tempDir simultaneously will not choose the - * same directory. It is the caller's responsibility to remove the directory - * when no longer needed. +/** Creates a new temporary directory in the directory `dir`, its name + * beginning with `prefix` and ending with `suffix`. + * + * It resolves to the full path to the newly created directory. + * + * If `dir` is unspecified, uses the default directory for temporary files. + * Multiple programs calling this function simultaneously will create different + * directories. It is the caller's responsibility to remove the directory when + * no longer needed. * * const tempDirName0 = await Deno.makeTempDir(); * const tempDirName1 = await Deno.makeTempDir({ prefix: 'my_temp' }); - */ + * + * Requires `allow-write` permission. */ export async function makeTempDir( options: MakeTempOptions = {} ): Promise<string> { return await sendAsync("op_make_temp_dir", options); } -/** makeTempFileSync is the synchronous version of `makeTempFile`. +/** Synchronously creates a new temporary file in the directory `dir`, its name + * beginning with `prefix` and ending with `suffix`. + * + * It returns the full path to the newly created file. + * + * If `dir` is unspecified, uses the default directory for temporary files. + * Multiple programs calling this function simultaneously will create different + * files. It is the caller's responsibility to remove the file when + * no longer needed. * * const tempFileName0 = Deno.makeTempFileSync(); * const tempFileName1 = Deno.makeTempFileSync({ prefix: 'my_temp' }); - */ + * + * Requires `allow-write` permission. */ export function makeTempFileSync(options: MakeTempOptions = {}): string { return sendSync("op_make_temp_file", options); } -/** makeTempFile creates a new temporary file in the directory `dir`, its - * name beginning with `prefix` and ending with `suffix`. - * It returns the full path to the newly created file. - * If `dir` is unspecified, tempFile uses the default directory for temporary - * files. Multiple programs calling tempFile simultaneously will not choose the - * same directory. It is the caller's responsibility to remove the file - * when no longer needed. +/** Creates a new temporary file in the directory `dir`, its name + * beginning with `prefix` and ending with `suffix`. + * + * It resolves to the full path to the newly created file. + * + * If `dir` is unspecified, uses the default directory for temporary files. + * Multiple programs calling this function simultaneously will create different + * files. It is the caller's responsibility to remove the file when + * no longer needed. * * const tempFileName0 = await Deno.makeTempFile(); * const tempFileName1 = await Deno.makeTempFile({ prefix: 'my_temp' }); - */ + * + * Requires `allow-write` permission. */ export async function makeTempFile( options: MakeTempOptions = {} ): Promise<string> { |