stopgap

stopgap

一時的なディレクトリを簡単に作成/削除します

一時的なディレクトリを作成するための迅速かつ簡単な方法が必要な場合があります。ディレクトリは、標準のOS一時的なディレクトリに作成されます。

さらに、このモジュールは次のように配信されます。

• ESモジュール： dist/stopgap.mjs
• commonjs ： dist/stopgap.js

インストール

 $ npm install --save stopgap

使用法

 import stopgap from 'stopgap' ;

const { path , remove } = await stopgap ( ) ;
// path ~> /var/folders/c7/fqpgnx7x5654w6z_k3syl11r0000gn/T/sg-LC48Pf
// remove ~> call function to delete directory

// clean up
await remove ( ) ; 

API

stopgap（opts）

returns： { path: String, remove: Function }

OSデフォルトのTEMPディレクトリに一時ディレクトリを作成し、2つのプロパティを持つANオブジェクトを返します。

パス

タイプ： String

作成されたディレクトリへのpath 。
デフォルトでは、これはユーザーホームディレクトリの非表示フォルダーとして作成されます。

取り除く

タイプ： Function返品： Promise

この関数を呼び出すと、一時的なディレクトリが削除されてクリーンアウトされます。

重要：ディレクトリ内のすべてが再帰的に削除されます。

opts.prefix

タイプ： String

フォルダーのカスタムプレフィックス。デフォルトはsg-です。

opts.dir

タイプ： String

ディレクトリのカスタムパス。パスは再帰的に作成されます。

デフォルトはシステムTMPディレクトリになります。

ライセンス

MIT©Terkel Gjervig