UNPKG

@cowprotocol/cow-sdk

Version:

<p align="center"> <img width="400" src="https://github.com/cowprotocol/cow-sdk/raw/main/docs/images/CoW.png" /> </p>

112 lines (60 loc) • 2.52 kB
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
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
# tempy [![Build Status](https://travis-ci.com/sindresorhus/tempy.svg?branch=master)](https://travis-ci.com/github/sindresorhus/tempy) > Get a random temporary file or directory path ## Install ``` $ npm install tempy ``` ## Usage ```js const tempy = require('tempy'); tempy.file(); //=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/4f504b9edb5ba0e89451617bf9f971dd' tempy.file({extension: 'png'}); //=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/a9fb0decd08179eb6cf4691568aa2018.png' tempy.file({name: 'unicorn.png'}); //=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/f7f62bfd4e2a05f1589947647ed3f9ec/unicorn.png' tempy.directory(); //=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/2f3d094aec2cb1b93bb0f4cffce5ebd6' tempy.directory({prefix: 'name'}); //=> '/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T/name_3c085674ad31223b9653c88f725d6b41' ``` ## API ### tempy.file(options?) Get a temporary file path you can write to. #### options Type: `object` *You usually won't need either the `extension` or `name` option. Specify them only when actually needed.* ##### extension Type: `string` File extension. ##### name Type: `string` Filename. Mutually exclusive with the `extension` option. ### tempy.directory([options]) Get a temporary directory path. The directory is created for you. #### options Type: `Object` ##### prefix Type: `string` Directory prefix. Useful for testing by making it easier to identify cache directories that are created. *You usually won't need this option. Specify it only when actually needed.* ### tempy.write(fileContent, options?) Write data to a random temp file. ##### fileContent Type: `string | Buffer | TypedArray | DataView | stream.Readable` Data to write to the temp file. ##### options See [options](#options). ### tempy.writeSync(fileContent, options?) Synchronously write data to a random temp file. ##### fileContent Type: `string | Buffer | TypedArray | DataView` Data to write to the temp file. ##### options See [options](#options). ### tempy.root Get the root temporary directory path. For example: `/private/var/folders/3x/jf5977fn79jbglr7rk0tq4d00000gn/T` ## FAQ #### Why doesn't it have a cleanup method? Temp files will be periodically cleaned up on macOS. Most Linux distros will clean up on reboot. If you're generating a lot of temp files, it's recommended to use a complementary module like [`del`](https://github.com/sindresorhus/del) for cleanup.