whet 0.0.1

package/bin/js/node/Fs.d.ts

@@ -0,0 +1,308 @@
+import {Buffer} from "buffer"
+
+/**
+Most FS functions now support passing `String` and `Buffer`.
+This type is used for path arguments and allows passing either of those.
+*/
+export type FsPath = string | Buffer
+
+/**
+Possible options for `Fs.watchFile`.
+*/
+export type FsWatchFileOptions = {
+	/**
+	indicates how often the target should be polled, in milliseconds
+	default: 5007
+	*/
+	interval?: null | number, 
+	/**
+	indicates whether the process should continue to run as long as files are being watched
+	default: true
+	*/
+	persistent?: null | boolean
+}
+
+/**
+The `mode` argument used by `Fs.open` and related functions
+can be either an integer or a string with octal number.
+*/
+export type FsMode = number | string
+
+/**
+Possible options for `Fs.writeFile` and `Fs.appendFile`.
+*/
+export type FsWriteFileOptions = {
+	/**
+	Encoding for writing strings.
+	Defaults to 'utf8'.
+	Ignored if data is a buffer
+	*/
+	encoding?: null | string, 
+	/**
+	default: 'w' for `Fs.writeFile`, 'a' for `Fs.appendFile`
+	*/
+	flag?: null | string, 
+	/**
+	default = 438 (aka 0666 in Octal)
+	*/
+	mode?: any
+}
+
+/**
+Defaults:
+{ flags: 'r',
+encoding: null,
+fd: null,
+mode: 0666,
+autoClose: true
+}
+*/
+export type FsCreateReadStreamOptions = {
+	/**
+	If autoClose is false, then the file descriptor won't be closed, even if there's an error.
+	It is your responsiblity to close it and make sure there's no file descriptor leak.
+	
+	If autoClose is set to true (default behavior), on error or end the file
+	descriptor will be closed automatically.
+	*/
+	autoClose?: null | boolean, 
+	/**
+	can be 'utf8', 'ascii', or 'base64'.
+	default: null
+	*/
+	encoding?: null | string, 
+	/**
+	End of the range of bytes to read
+	*/
+	end?: null | number, 
+	/**
+	default: null
+	*/
+	fd?: null | number, 
+	/**
+	default: 'r'
+	*/
+	flags?: null | string, 
+	/**
+	default: 0666
+	*/
+	mode?: any, 
+	/**
+	Start of the range of bytes to read
+	*/
+	start?: null | number
+}
+
+/**
+Options for `Fs.createWriteStream`.
+*/
+export type FsCreateWriteStreamOptions = {
+	/**
+	default: null
+	*/
+	encoding?: null | string, 
+	/**
+	default: 'w'
+	*/
+	flags?: null | string, 
+	/**
+	default: 0666
+	*/
+	mode?: any, 
+	/**
+	position to write data the beginning of the file.
+	*/
+	start?: null | number
+}
+
+/**
+Constants for use in `Fs` module.
+
+Note: Not every constant will be available on every operating system.
+*/
+export type FsConstants = {
+	/**
+	Flag indicating that the file is visible to the calling process.
+	Meant for use with `Fs.access`.
+	*/
+	F_OK: number, 
+	/**
+	Flag indicating that data will be appended to the end of the file.
+	*/
+	O_APPEND: number, 
+	/**
+	Flag indicating to create the file if it does not already exist.
+	*/
+	O_CREAT: number, 
+	/**
+	When set, an attempt will be made to minimize caching effects of file I/O.
+	*/
+	O_DIRECT: number, 
+	/**
+	Flag indicating that the open should fail if the path is not a directory.
+	*/
+	O_DIRECTORY: number, 
+	/**
+	Flag indicating that opening a file should fail if the O_CREAT flag is set and the file already exists.
+	*/
+	O_EXCL: number, 
+	/**
+	Flag indicating reading accesses to the file system will no longer result in an update to the atime information associated with the file. This flag is available on Linux operating systems only.
+	*/
+	O_NOATIME: number, 
+	/**
+	Flag indicating that if path identifies a terminal device, opening the path shall not cause that terminal to become the controlling terminal for the process (if the process does not already have one).
+	*/
+	O_NOCTTY: number, 
+	/**
+	Flag indicating that the open should fail if the path is a symbolic link.
+	*/
+	O_NOFOLLOW: number, 
+	/**
+	Flag indicating to open the file in nonblocking mode when possible.
+	*/
+	O_NONBLOCK: number, 
+	/**
+	Flag indicating to open a file for read-only access.
+	*/
+	O_RDONLY: number, 
+	/**
+	Flag indicating to open a file for read-write access.
+	*/
+	O_RDWR: number, 
+	/**
+	Flag indicating to open the symbolic link itself rather than the resource it is pointing to.
+	*/
+	O_SYMLINK: number, 
+	/**
+	Flag indicating that the file is opened for synchronous I/O.
+	*/
+	O_SYNC: number, 
+	/**
+	Flag indicating that if the file exists and is a regular file, and the file is opened successfully for write access, its length shall be truncated to zero.
+	*/
+	O_TRUNC: number, 
+	/**
+	Flag indicating to open a file for write-only access.
+	*/
+	O_WRONLY: number, 
+	/**
+	Flag indicating that the file can be read by the calling process.
+	Meant for use with `Fs.access`.
+	*/
+	R_OK: number, 
+	/**
+	File type constant for a block-oriented device file.
+	*/
+	S_IFBLK: number, 
+	/**
+	File type constant for a character-oriented device file.
+	*/
+	S_IFCHR: number, 
+	/**
+	File type constant for a directory.
+	*/
+	S_IFDIR: number, 
+	/**
+	File type constant for a FIFO/pipe.
+	*/
+	S_IFIFO: number, 
+	/**
+	File type constant for a symbolic link.
+	*/
+	S_IFLNK: number, 
+	/**
+	Bit mask used to extract the file type code.
+	*/
+	S_IFMT: number, 
+	/**
+	File type constant for a regular file.
+	*/
+	S_IFREG: number, 
+	/**
+	File type constant for a socket.
+	*/
+	S_IFSOCK: number, 
+	/**
+	File mode indicating readable by group.
+	*/
+	S_IRGRP: number, 
+	/**
+	File mode indicating readable by others.
+	*/
+	S_IROTH: number, 
+	/**
+	File mode indicating readable by owner.
+	*/
+	S_IRUSR: number, 
+	/**
+	File mode indicating readable, writable and executable by group.
+	*/
+	S_IRWXG: number, 
+	/**
+	File mode indicating readable, writable and executable by others.
+	*/
+	S_IRWXO: number, 
+	/**
+	File mode indicating readable, writable and executable by owner.
+	*/
+	S_IRWXU: number, 
+	/**
+	File mode indicating writable by group.
+	*/
+	S_IWGRP: number, 
+	/**
+	File mode indicating writable by others.
+	*/
+	S_IWOTH: number, 
+	/**
+	File mode indicating writable by owner.
+	*/
+	S_IWUSR: number, 
+	/**
+	File mode indicating executable by group.
+	*/
+	S_IXGRP: number, 
+	/**
+	File mode indicating executable by others.
+	*/
+	S_IXOTH: number, 
+	/**
+	File mode indicating executable by owner.
+	*/
+	S_IXUSR: number, 
+	/**
+	Flag indicating that the file can be written by the calling process.
+	Meant for use with `Fs.access`.
+	*/
+	W_OK: number, 
+	/**
+	Flag indicating that the file can be executed by the calling process.
+	Meant for use with `Fs.access`.
+	*/
+	X_OK: number
+}
+
+/**
+Options for `Fs.rmdir` and `Fs.rmdirSync`.
+*/
+export type FsRmdirOptions = {
+	/**
+	If an `EBUSY`, `EMFILE`, `ENFILE`, `ENOTEMPTY`, or `EPERM` error is encountered,
+	Node.js will retry the operation with a linear backoff wait of `retryDelay` ms longer on each try.
+	This option represents the number of retries.
+	This option is ignored if the `recursive` option is not `true`.
+	*/
+	maxRetries?: null | number, 
+	/**
+	If `true`, perform a recursive directory removal.
+	In recursive mode, errors are not reported if `path` does not exist,
+	and operations are retried on failure.
+	*/
+	recursive?: null | boolean, 
+	/**
+	The amount of time in milliseconds to wait between retries.
+	This option is ignored if the `recursive` option is not `true`.
+	*/
+	retryDelay?: null | number
+}

package/bin/js/node/Http.d.ts

@@ -0,0 +1,114 @@
+import {SocketConnectOptionsTcp} from "./net/Socket"
+import {Agent} from "http"
+
+export type HttpCreateServerOptions = {
+	/**
+	Specifies the `IncomingMessage` class to be used. Useful for extending the original `IncomingMessage`.
+	
+	Default: `js.node.http.IncomingMessage`.
+	*/
+	IncomingMessage?: null | any, 
+	/**
+	Specifies the `ServerResponse` class to be used. Useful for extending the original `ServerResponse`.
+	
+	Default: `ServerResponse`.
+	*/
+	ServerResponse?: null | any
+}
+
+/**
+Type of the options object passed to `Http.request`.
+*/
+export type HttpRequestOptions = {
+	/**
+	Controls Agent behavior.
+	
+	Possible values:
+	
+	- `undefined` (default): use http.globalAgent for this host and port.
+	- `Agent` object: explicitly use the passed in `Agent`.
+	- `false` : causes a new `Agent` with default values to be used.
+	*/
+	agent?: null | Agent | boolean, 
+	/**
+	Basic authentication i.e. `'user:password'` to compute an Authorization header.
+	*/
+	auth?: null | string, 
+	/**
+	A function that produces a socket/stream to use for the request when the `agent` option is not used.
+	This can be used to avoid creating a custom `Agent` class just to override the default `createConnection` function.
+	See [agent.createConnection()](https://nodejs.org/api/http.html#http_agent_createconnection_options_callback) for more details.
+	Any `Duplex` stream is a valid return value.
+	*/
+	createConnection?: null | ((options: SocketConnectOptionsTcp, callabck?: ((err: Error, stream: IDuplex) => void)) => IDuplex), 
+	/**
+	Default port for the protocol.
+	
+	Default: `agent.defaultPort` if an Agent is used, else `undefined`.
+	*/
+	defaultPort?: null | number, 
+	/**
+	IP address family to use when resolving `host` or `hostname`.
+	Valid values are `4` or `6`. When unspecified, both IP v4 and v6 will be used.
+	*/
+	family?: null | number, 
+	/**
+	An object containing request headers.
+	*/
+	headers?: null | {[key: string]: string | string[]}, 
+	/**
+	A domain name or IP address of the server to issue the request to.
+	
+	Default: `'localhost'`.
+	*/
+	host?: null | string, 
+	/**
+	Alias for `host`.
+	To support `url.parse()`, hostname will be used if both `host` and `hostname` are specified.
+	*/
+	hostname?: null | string, 
+	/**
+	Local interface to bind for network connections.
+	*/
+	localAddress?: null | string, 
+	/**
+	A string specifying the HTTP request method.
+	
+	Default: `'GET'`.
+	*/
+	method?: null | string, 
+	/**
+	Request path. Should include query string if any. E.G. `'/index.html?page=12'`.
+	An exception is thrown when the request path contains illegal characters.
+	Currently, only spaces are rejected but that may change in the future.
+	
+	Default: `'/'`.
+	*/
+	path?: null | string, 
+	/**
+	Port of remote server.
+	
+	Default: `defaultPort` if set, else `80`.
+	*/
+	port?: null | number, 
+	/**
+	Protocol to use.
+	
+	Default: `'http:'`.
+	*/
+	protocol?: null | string, 
+	/**
+	Specifies whether or not to automatically add the Host header.
+	Defaults to `true`.
+	*/
+	setHost?: null | boolean, 
+	/**
+	Unix Domain Socket (cannot be used if one of host or port is specified, those specify a TCP Socket).
+	*/
+	socketPath?: null | string, 
+	/**
+	A number specifying the socket timeout in milliseconds.
+	This will set the timeout before the socket is connected.
+	*/
+	timeout?: null | number
+}