API:w96.FS - Revision history

Kelbaz: Filled every single methods

2023-12-22T18:53:09Z

Filled every single methods

← Older revision		Revision as of 20:53, 22 December 2023
Line 91:		Line 91:
	Renames a file or folder.		Renames a file or folder.

	=== <code>readBinChunk()</code> ===		=== <code>readBinChunk(path: String, start?: Number, end?: Number): Promise<Uint8Array></code> ===
			Returns a slice of a file binary data from a path, a start and an end index.

	=== <code>readStrChunk()</code> ===		=== <code>readStrChunk(path: String, start?: Number, end?: Number): Promise<String></code> ===
			Returns a slice of a file as a string from a path, a start and an end index.

	=== <code>cache()</code> ===		=== <code>cache(path: String, params: { type: "binary" \| "string" \| "blob", overwrite: Boolean }): Promise<void></code> ===
			Caches a file from a given path depending on parameters like the overwriting or the file type.

	=== <code>uncache()</code> ===		=== <code>uncache(path: String): void</code> ===
			Uncaches the file at a specified path.

	=== <code>getFromCache()</code> ===		=== <code>getFromCache(path: String): Uint8Array \| String \| Blob \| undefined</code> ===
			Gives the the data from the cached file at a specified path. If the file wasn't cached, it returns <code>undefined</code>.

	=== <code>hash(path: String, algorithm: "default" \| "md5" \| "sha256" \| "sha512"): Promise<String></code> ===		=== <code>hash(path: String, algorithm: "default" \| "md5" \| "sha256" \| "sha512"): Promise<String></code> ===
	~~Create~~ a hash from a given path and algorithm.		Creates a hash from a given path and algorithm.

	=== <code>assert()</code> ===		=== <code>assert(path: String): Promise<void></code> ===
			Checks if a file exists at a specific path. If not, it will throw an <code>Error</code>.
	[[Category:API]]		[[Category:API]]

Kelbaz: Dare you scan mode!

2023-10-26T15:54:40Z

Dare you scan mode!

← Older revision		Revision as of 17:54, 26 October 2023
Line 46:		Line 46:
	Deletes a file at the specified path.		Deletes a file at the specified path.

	=== <code>readdir(path: String): String[]</code> ===		=== <code>readdir(path: String, scan_mode: Boolean): String[]</code> ===

			* If scan_mode is set to true, then the filetype is included with the path

	Returns a list of entities contained in the specified path.		Returns a list of entities contained in the specified path.

Utf: Reverted edits by 94.233.241.205 (talk) to last revision by Utf

2023-05-16T16:35:57Z

Reverted edits by 94.233.241.205 (talk) to last revision by Utf

Show changes

94.233.241.205: SEXX

2023-05-16T06:57:50Z

SEXX

Show changes

Utf: Spelling: Primise -> Promise

2023-03-22T23:59:35Z

Spelling: Primise -> Promise

← Older revision		Revision as of 01:59, 23 March 2023
Line 19:		Line 19:
	Get the next available drive letter.		Get the next available drive letter.

	=== <code>toBlob(path: String): ~~Primise~~<Blob></code> ===		=== <code>toBlob(path: String): Promise<Blob></code> ===
	Creates a blob from a specified path.		Creates a blob from a specified path.

Line 25:		Line 25:
	Retuns a file system by its prefix.		Retuns a file system by its prefix.

	=== <code>toURL(path: String): ~~Primise~~<String></code> ===		=== <code>toURL(path: String): Promise<String></code> ===
	Creates a URL from the specified file path.		Creates a URL from the specified file path.

	=== <code>isFile(path: String): ~~Primise~~<Boolean></code> ===		=== <code>isFile(path: String): Promise<Boolean></code> ===
	Returns <code>true</code> if the entry is a file.		Returns <code>true</code> if the entry is a file.

	=== <code>isEmpty(path: String): ~~Primise~~<Boolean></code> ===		=== <code>isEmpty(path: String): Promise<Boolean></code> ===
	Returns <code>true</code> if the file is empty.		Returns <code>true</code> if the file is empty.

	=== <code>mkdir(path: String): ~~Primise~~<Boolean></code> ===		=== <code>mkdir(path: String): Promise<Boolean></code> ===
	Creates a directory at the specified path.		Creates a directory at the specified path.

	=== <code>rmdir(path: String): ~~Primise~~<Boolean></code> ===		=== <code>rmdir(path: String): Promise<Boolean></code> ===
	Deletes a directory at the specified path.		Deletes a directory at the specified path.

	=== <code>touch(path: String): ~~Primise~~<Boolean></code> ===		=== <code>touch(path: String): Promise<Boolean></code> ===
	Creates a file at the specified path.		Creates a file at the specified path.

	=== <code>rm(path: String): ~~Primise~~<Boolean></code> ===		=== <code>rm(path: String): Promise<Boolean></code> ===
	Deletes a file at the specified path.		Deletes a file at the specified path.

Kelbaz: Started this page

2023-03-22T15:32:20Z

Started this page

New page

=== <code>class FS</code> ===
This namespace refers to the file system API of Windows 96. <code>w96.FS</code> allows manipulation of file system entries by, for example, renaming, deleting or copying them. It is also possible to create, read and write files and directories.

== Structure ==

=== <code>mount(fso: IFileSystem): Promise<void></code> ===
Mounts a file system using the specified object ("driver").

=== <code>umount(prefix: String): Promise<void></code> ===
Unmounts a file system instance.

=== <code>mounts(): IFileSystem[]</code> ===
Gets all mounted file systems.

=== <code>list(): String[]</code> ===
Gets all mounted file system prefixes.

=== <code>nextLetter(): String</code> ===
Get the next available drive letter.

=== <code>toBlob(path: String): Primise<Blob></code> ===
Creates a blob from a specified path.

=== <code>get(prefix: String): IFileSystem</code> ===
Retuns a file system by its prefix.

=== <code>toURL(path: String): Primise<String></code> ===
Creates a URL from the specified file path.

=== <code>isFile(path: String): Primise<Boolean></code> ===
Returns <code>true</code> if the entry is a file.

=== <code>isEmpty(path: String): Primise<Boolean></code> ===
Returns <code>true</code> if the file is empty.

=== <code>mkdir(path: String): Primise<Boolean></code> ===
Creates a directory at the specified path.

=== <code>rmdir(path: String): Primise<Boolean></code> ===
Deletes a directory at the specified path.

=== <code>touch(path: String): Primise<Boolean></code> ===
Creates a file at the specified path.

=== <code>rm(path: String): Primise<Boolean></code> ===
Deletes a file at the specified path.

=== <code>readdir(path: String): String[]</code> ===
Returns a list of entities contained in the specified path.

=== <code>cpdir(src: String, dest: String): Promise<Boolean></code> ===
Copies a directory to a new destination.

=== <code>cpfile(src: String, dest: String): Promise<Boolean></code> ===
Copies a file to a new destination.

=== <code>mvfile(src: String, dest: String): Promise<Boolean></code> ===
Moves a file to a new destination.

=== <code>mvdir(src: String, dest: String): Promise<Boolean></code> ===
Moves a directory to a new destination.

=== <code>exists(path: String): Boolean</code> ===
Checks if an entity exists.

=== <code>readstr(path: String): Promise<String></code> ===
Reads the specified file as a string.

=== <code>readbin(path: String): Promise<Uint8Array></code> ===
Reads the specified file as binary.

=== <code>filetype(path: String): 0 | 1 | -1</code> ===
Returns the file type of a node. This can be a binary or text file.

=== <code>writestr(path: String, data: String): Promise<Boolean></code> ===
Truncates and writes a UTF-8 encoded string to the specified file.

=== <code>writebin(path: String, data: Uint8Array | Number[]): Promise<Boolean></code> ===
Truncates and writes data to the specified file.

=== <code>walk(path: String): String[]</code> ===
Walks through the contents of a directory.

=== <code>stat(path: String): FSStatResult</code> ===
Retrieves information about a file system entry.

=== <code>rename(path: String, newName: String): Promise<Boolean></code> ===
Renames a file or folder.

=== <code>readBinChunk()</code> ===

=== <code>readStrChunk()</code> ===

=== <code>cache()</code> ===

=== <code>uncache()</code> ===

=== <code>getFromCache()</code> ===

=== <code>hash(path: String, algorithm: "default" | "md5" | "sha256" | "sha512"): Promise<String></code> ===
Create a hash from a given path and algorithm.

=== <code>assert()</code> ===
[[Category:API]]