From 56dee133e9d7fc984150b7903ee171a89541cb1b Mon Sep 17 00:00:00 2001 From: Carsten Klein Date: Fri, 1 May 2020 09:54:09 +0200 Subject: [PATCH] =?UTF-8?q?=F0=9F=A4=96=20Merge=20PR=20#44359=20Update=20t?= =?UTF-8?q?ypes=20for=20tmp=20to=20the=20latest=20version=20of=20the=20API?= =?UTF-8?q?=20by=20@silkentrance?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- types/tmp/index.d.ts | 27 +++++++++------ types/tmp/tmp-tests.ts | 77 +++++++++++++++++++++++++++--------------- 2 files changed, 65 insertions(+), 39 deletions(-) diff --git a/types/tmp/index.d.ts b/types/tmp/index.d.ts index b761fd3717..e60fd207c6 100644 --- a/types/tmp/index.d.ts +++ b/types/tmp/index.d.ts @@ -1,28 +1,31 @@ -// Type definitions for tmp 0.1 +// Type definitions for tmp 0.2 // Project: http://github.com/raszi/node-tmp // Definitions by: Jared Klopper // Gyusun Yeom // Alan Plum +// Carsten Klein // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped export interface TmpNameOptions { - prefix?: string; - postfix?: string; - template?: string; dir?: string; + name?: string; + postfix?: string; + prefix?: string; + template?: string; + tmpdir?: string; tries?: number; } export interface FileOptions extends TmpNameOptions { - mode?: number; - keep?: boolean; - discardDescriptor?: boolean; detachDescriptor?: boolean; + discardDescriptor?: boolean; + keep?: boolean; + mode?: number; } export interface DirOptions extends TmpNameOptions { - mode?: number; keep?: boolean; + mode?: number; unsafeCleanup?: boolean; } @@ -38,19 +41,21 @@ export interface DirResult { } export type FileCallback = ( - err: any, + err: Error|null, name: string, fd: number, removeCallback: () => void ) => void; export type DirCallback = ( - err: any, + err: Error|null, name: string, removeCallback: () => void ) => void; -export type TmpNameCallback = (err: any, name: string) => void; +export type TmpNameCallback = (err: Error|null, name: string) => void; + +export const tmpdir: string; export function file(options: FileOptions, cb: FileCallback): void; export function file(cb: FileCallback): void; diff --git a/types/tmp/tmp-tests.ts b/types/tmp/tmp-tests.ts index 901ed454f3..ef2702f98a 100644 --- a/types/tmp/tmp-tests.ts +++ b/types/tmp/tmp-tests.ts @@ -1,15 +1,20 @@ import { - dir, DirResult, + FileResult, + tmpdir, + tmpName, + tmpNameSync, + dir, dirSync, file, - FileResult, fileSync, - setGracefulCleanup, - tmpName, - tmpNameSync + setGracefulCleanup } from "tmp"; +console.log(tmpdir); + +setGracefulCleanup(); + file((err, name, fd, removeCallback) => { if (err) throw err; @@ -19,6 +24,13 @@ file((err, name, fd, removeCallback) => { removeCallback(); }); +file({ mode: 644, prefix: "prefix-", postfix: ".txt" }, (err, name, fd) => { + if (err) throw err; + + console.log("File name: ", name); + console.log("File descriptor: ", fd); +}); + dir((err, name, removeCallback) => { if (err) throw err; @@ -27,51 +39,60 @@ dir((err, name, removeCallback) => { removeCallback(); }); -tmpName((err, name) => { - if (err) throw err; - - console.log("Created temporary filename: ", name); -}); - -file({ mode: 644, prefix: "prefix-", postfix: ".txt" }, (err, name, fd) => { - if (err) throw err; - - console.log("File name: ", name); - console.log("File descriptor: ", fd); -}); - dir({ mode: 750, prefix: "myTmpDir_" }, (err, name) => { if (err) throw err; console.log("Dir name: ", name); }); +tmpName((err, name) => { + if (err) throw err; + + console.log("Created temporary filename: ", name); +}); + tmpName({ template: "/tmp/tmp-XXXXXX" }, (err, name) => { if (err) throw err; console.log("Created temporary filename: ", name); }); -setGracefulCleanup(); +tmpName({ name: "fixed-name", dir: "relative" }, (err, name) => { + if (err) throw err; + + console.log("Created temporary filename: ", name); +}); + +tmpName({ tmpdir: "/overridden/tmp/root" }, (err, name) => { + if (err) throw err; + + console.log("Created temporary filename: ", name); +}); + +let tmpDir: DirResult = dirSync(); +console.log("Dir name: ", tmpDir.name); +tmpDir.removeCallback(); + +tmpDir = dirSync({ mode: 750, prefix: "myTmpDir_" }); +console.log("Dir: ", tmpDir.name); let tmpFile: FileResult = fileSync(); console.log("File name: ", tmpFile.name); console.log("File descriptor: ", tmpFile.fd); tmpFile.removeCallback(); -let tmpDir: DirResult = dirSync(); -console.log("Dir name: ", tmpDir.name); -tmpDir.removeCallback(); - -let name: string = tmpNameSync(); -console.log("Created temporary filename: ", name); - tmpFile = fileSync({ mode: 644, prefix: "prefix-", postfix: ".txt" }); console.log("File name: ", tmpFile.name); console.log("File descriptor: ", tmpFile.fd); -tmpDir = dirSync({ mode: 750, prefix: "myTmpDir_" }); -console.log("Dir: ", tmpDir.name); +let name: string = tmpNameSync(); +console.log("Created temporary filename: ", name); name = tmpNameSync({ template: "/tmp/tmp-XXXXXX" }); console.log("Created temporary filename: ", name); + +name = tmpNameSync({ name: "fixed-name", dir: "relative" }); +console.log("Created temporary filename: ", name); + +name = tmpNameSync({ tmpdir: "/overridden/tmp/root" }); +console.log("Created temporary filename: ", name);