diff --git a/docs/global.html b/docs/global.html index d536f04..22766d4 100644 --- a/docs/global.html +++ b/docs/global.html @@ -251,7 +251,7 @@
Parameters:
Source:
@@ -388,7 +388,7 @@
Parameters:
Source:
@@ -628,7 +628,7 @@
Parameters:
Source:
@@ -765,7 +765,7 @@
Parameters:
Source:
@@ -908,7 +908,7 @@

set
Source:
@@ -1091,7 +1091,7 @@

Parameters:
Source:
@@ -1228,7 +1228,7 @@
Parameters:
Source:
@@ -1317,33 +1317,32 @@

Type Definitions

+

DirSyncObject

- - - -

cleanupCallback(nextopt)

- - -
- Removes the temporary created file or directory. -
+
Type:
+ +
Properties:
-
Parameters:
- +
@@ -1353,8 +1352,6 @@
Parameters:
- - @@ -1367,128 +1364,51 @@
Parameters:
- + - - - + - -
TypeAttributes
nextname -simpleCallback +string - - <optional>
- - - - - -
function to call whenever the tmp object needs to be removedthe name of the directory
- - - - - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - -
Source:
-
- - - - - - - -
- - - - - - - - - - - - - - - - - - + + + removeCallback + + - - - - -

cleanupCallbackSync()

- - - - - - -
- Removes the temporary created file or directory. -
- - - +fileCallback + + + + + the callback function to remove the directory + + + + @@ -1522,7 +1442,7 @@

cl
Source:
@@ -1537,46 +1457,35 @@

cl - - - - - - - - - - - - - - +

FileSyncObject

- - -

dirCallback(errnullable, name, fn)

- - +
Type:
+ +
Properties:
-
Parameters:
- +
@@ -1586,8 +1495,6 @@
Parameters:
- - @@ -1600,40 +1507,30 @@
Parameters:
- + - - - - + - + - - - + - + - - - + @@ -1698,8 +1579,6 @@
Parameters:
- -
@@ -1729,7 +1608,7 @@
Parameters:
Source:
@@ -1744,46 +1623,39 @@
Parameters:
- - - - - - - - - - - - - - +

Options

- - -

dirCallbackSync(errnullable, name, fn)

- - +
+ Configuration options. +
+
Type:
+ -
Parameters:
+
Properties:
+ -
TypeAttributes
errname -Error +string - - - <nullable>
- - - -
the error object if anything goes wrongthe name of the file
namefd @@ -1646,49 +1543,33 @@
Parameters:
- - - - - - the temporary file namethe file descriptor or -1 if the fd has been discarded
fnremoveCallback -cleanupCallback +fileCallback - - - - - - the cleanup callback functionthe callback function to remove the file
+
@@ -1807,13 +1679,13 @@
Parameters:
- + - + - + - + - + @@ -1888,173 +1753,291 @@
Parameters:
- - - + - -
errkeep -Error +boolean @@ -1826,27 +1698,25 @@
Parameters:
<nullable>
- -
the error object if anything goes wrongthe temporary object (file or dir) will not be garbage collected
nametries -string +number @@ -1857,30 +1727,25 @@
Parameters:
- + <nullable>
the temporary file namethe number of tries before give up the name generation
fn(?int) - -cleanupCallbackSync - - - the cleanup callback functionmode the access mode, defaults are 0o700 for directories and 0o600 for files
- + + + template + + + + +string + + -
+ + + - + + <nullable>
+ + + - + - + the "mkstemp" like filename template + - + + + name + - + + + +string - - + + - + + + - + + <nullable>
+ + + - + - + fixed name relative to tmpdir or the specified dir option + - -
Source:
-
- + + + dir + - + + + +string - -
+ + + + + + + <nullable>
+ + + + + tmp directory relative to the root tmp directory in use + + + + + prefix + + + + +string + + + + + + + <nullable>
+ + + + + prefix for the generated name + + + + + postfix + + + + +string + + + -

DirSyncObject

- + + <nullable>
+ + + + + postfix for the generated name + + -
Type:
- + + + + + + + <nullable>
+ + + + -
Properties:
+ the root tmp directory which overrides the os tmpdir + - - - - - - + + + + - + - - - + + + + + + + + - - + + + - + - + + + - + @@ -2093,7 +2076,7 @@
Properties:
Source:
@@ -2115,13 +2098,17 @@
Properties:
-

fileCallback(errnullable, name, fd, fn)

+

cleanupCallback(nextopt)

+
+ Removes the temporary created file or directory. +
+ @@ -2157,13 +2144,13 @@
Parameters:
- + + + +
Name
unsafeCleanupType + + +boolean - - + + Description
+ + + + <nullable>
+ +
recursively removes the created temporary directory, even when it's not empty
namedetachDescriptor -string +boolean + + + + <nullable>
+ +
the name of the directorydetaches the file descriptor, caller is responsible for closing the file, tmp will no longer try closing the file during garbage collection
removeCallbackdiscardDescriptor -fileCallback +boolean + + + + <nullable>
+ +
the callback function to remove the directorydiscards the file descriptor (closes file, fd is -1), tmp will no longer try closing the file during garbage collection
errnext -Error +simpleCallback @@ -2172,9 +2159,9 @@
Parameters:
- + <optional>
- <nullable>
+ @@ -2183,105 +2170,100 @@
Parameters:
-
the error object if anything goes wrongfunction to call whenever the tmp object needs to be removed
- - - name - - - - -string - - - - - - +
- - - + - + - the temporary file name - + - - - fd - + - - - -number + + - - + - - - + - + - - - + - + - the file descriptor or -1 if the fd had been discarded - + +
Source:
+
+ - - - fn - + + + +
+ + + + + + + + + + + + + - - - -cleanupCallback - - - - - - - - - + - the cleanup callback function - + - - +

cleanupCallbackSync()

+ + + + + + +
+ Removes the temporary created file or directory. +
+ + + + + + + @@ -2317,7 +2299,7 @@
Parameters:
Source:
@@ -2353,7 +2335,7 @@
Parameters:
-

fileCallbackSync(errnullable, name, fd, fn)

+

dirCallback(errnullable, name, fn)

@@ -2457,37 +2439,6 @@
Parameters:
- - - fd - - - - - -number - - - - - - - - - - - - - - - - - - the file descriptor or -1 if the fd had been discarded - - - - fn @@ -2496,7 +2447,7 @@
Parameters:
-cleanupCallbackSync +cleanupCallback @@ -2555,7 +2506,7 @@
Parameters:
Source:
@@ -2587,32 +2538,29 @@
Parameters:
-

FileSyncObject

+ + +

dirCallbackSync(errnullable, name, fn)

+ + -
Type:
- -
Properties:
+
Parameters:
- +
@@ -2622,6 +2570,8 @@
Properties:
+ + @@ -2634,30 +2584,40 @@
Properties:
- + + - + + + - + + + - + - + + + - + @@ -2706,6 +2682,8 @@
Properties:
+ +
@@ -2735,7 +2713,7 @@
Properties:
Source:
@@ -2751,38 +2729,45 @@
Properties:
- - -

Options

-
- Configuration options. -
-
Type:
- -
Properties:
+ + + + + + +

fileCallback(errnullable, name, fd, fn)

+ + + + + + + + + + + + + +
Parameters:
-
TypeAttributes
nameerr -string +Error + + + + <nullable>
+ + +
the name of the filethe error object if anything goes wrong
fdname @@ -2670,33 +2630,49 @@
Properties:
+ + + + + + the file descriptor or -1 if the fd has been discardedthe temporary file name
removeCallbackfn -fileCallback +cleanupCallbackSync + + + + + + the callback function to remove the filethe cleanup callback function
+
@@ -2806,13 +2791,13 @@
Properties:
- + - + - + - + - + @@ -2880,25 +2872,27 @@
Properties:
+ + - + - + - + + +
keeperr -boolean +Error @@ -2825,25 +2810,27 @@
Properties:
<nullable>
+ +
the temporary object (file or dir) will not be garbage collectedthe error object if anything goes wrong
triesname -number +string @@ -2854,25 +2841,30 @@
Properties:
- <nullable>
+
the number of tries before give up the name generationthe temporary file name
(?int)fd + +number + + + mode the access mode, defaults are 0o700 for directories and 0o600 for filesthe file descriptor or -1 if the fd had been discarded
templatefn -string +cleanupCallback @@ -2909,151 +2903,139 @@
Properties:
- <nullable>
+
the "mkstemp" like filename templatethe cleanup callback function
- - - name - - - - -string - - - - - - - <nullable>
- - - +
- + - fixed name relative to tmpdir or the specified dir option - + - - - dir - + - - - -string + + - - + - - - + - - <nullable>
- - - + - + - tmp directory relative to the root tmp directory in use - + - - - prefix - + +
Source:
+
+ + + + + + + +
+ + + + + + + - - - -string - - - - - - - <nullable>
- - - - - prefix for the generated name - - - - - postfix - - - - -string - - - - - <nullable>
- - - + - + +

fileCallbackSync(errnullable, name, fd, fn)

+ - postfix for the generated name - + + + + + + + + + + + + +
Parameters:
+ + + + + + + + + + + + + + + + + + + + + - + - + - + - + - + - + - + - + @@ -3174,6 +3158,8 @@
Properties:
+ +
@@ -3203,7 +3189,7 @@
Properties:
Source:
@@ -3218,6 +3204,20 @@
Properties:
+ + + + + + + + + + + + + + @@ -3277,7 +3277,7 @@

simpleC
Source:
@@ -3460,7 +3460,7 @@

Parameters:
Source:
@@ -3510,7 +3510,7 @@

Home

Global

NameTypeAttributesDescription
tmpdirerr -string +Error @@ -3066,25 +3048,27 @@
Properties:
<nullable>
+ +
the root tmp directory which overrides the os tmpdirthe error object if anything goes wrong
unsafeCleanupname -boolean +string @@ -3095,27 +3079,27 @@
Properties:
- <nullable>
+
recursively removes the created temporary directory, even when it's not emptythe temporary file name
detachDescriptorfd -boolean +number @@ -3126,27 +3110,27 @@
Properties:
- <nullable>
+
detaches the file descriptor, caller is responsible for closing the file, tmp will no longer try closing the file during garbage collectionthe file descriptor or -1 if the fd had been discarded
discardDescriptorfn -boolean +cleanupCallbackSync @@ -3157,14 +3141,14 @@
Properties:
- <nullable>
+
discards the file descriptor (closes file, fd is -1), tmp will no longer try closing the file during garbage collectionthe cleanup callback function