FileSystem | @vertx/core

Contains a broad set of operations for manipulating files on the file system.

A (potential) blocking and non blocking version of each operation is provided.

The non blocking versions take a handler which is called when the operation completes or an error occurs.

The blocking versions are named xxxBlocking and return the results, or throw exceptions directly. In many cases, depending on the operating system and file system some of the potentially blocking operations can return quickly, which is why we provide them, but it's highly recommended that you test how long they take to return in your particular application before using them on an event loop.

Please consult the documentation for more information on file system support.

Hierarchy

FileSystem

Index

Methods

chmod

chmod(path: string, perms: string): PromiseLike<void>
chmod(path: string, perms: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2420
Change the permissions on the file represented by path to perms, asynchronously.

The permission String takes the form rwxr-x--- as specified here.

Parameters
- path: string
- perms: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2428
Change the permissions on the file represented by path to perms, asynchronously.

The permission String takes the form rwxr-x--- as specified here.

Parameters
- path: string
- perms: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

chmodBlocking

chmodBlocking(path: string, perms: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2433
Blocking version of [#chmod(String, String, Handler)] FileSystem

Parameters
- path: string
- perms: string
Returns FileSystem

chmodRecursive

chmodRecursive(path: string, perms: string, dirPerms: string): PromiseLike<void>
chmodRecursive(path: string, perms: string, dirPerms: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2443
Change the permissions on the file represented by path to perms, asynchronously.
The permission String takes the form rwxr-x--- as specified in {here}.

If the file is directory then all contents will also have their permissions changed recursively. Any directory permissions will be set to dirPerms, whilst any normal file permissions will be set to perms.

Parameters
- path: string
- perms: string
- dirPerms: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2453
Change the permissions on the file represented by path to perms, asynchronously.
The permission String takes the form rwxr-x--- as specified in {here}.

If the file is directory then all contents will also have their permissions changed recursively. Any directory permissions will be set to dirPerms, whilst any normal file permissions will be set to perms.

Parameters
- path: string
- perms: string
- dirPerms: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

chmodRecursiveBlocking

chmodRecursiveBlocking(path: string, perms: string, dirPerms: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2458
Blocking version of {@link FileSystem#chmodRecursive}

Parameters
- path: string
- perms: string
- dirPerms: string
Returns FileSystem

chown

chown(path: string, user: string | null | undefined, group: string | null | undefined): PromiseLike<void>
chown(path: string, user: string | null | undefined, group: string | null | undefined, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2463
Change the ownership on the file represented by path to user and {code group}, asynchronously.

Parameters
- path: string
- user: string | null | undefined
- group: string | null | undefined
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2468
Change the ownership on the file represented by path to user and {code group}, asynchronously.

Parameters
- path: string
- user: string | null | undefined
- group: string | null | undefined
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

chownBlocking

chownBlocking(path: string, user: string | null | undefined, group: string | null | undefined): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2474
Blocking version of {@link FileSystem#chown}

Parameters
- path: string
- user: string | null | undefined
- group: string | null | undefined
Returns FileSystem

copy

copy(from: string, to: string): PromiseLike<void>
copy(from: string, to: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem
copy(from: string, to: string, options: CopyOptions): PromiseLike<void>
copy(from: string, to: string, options: CopyOptions, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2317
Copy a file from the path from to path to, asynchronously.

The copy will fail if the destination already exists.

Parameters
- from: string
- to: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2324
Copy a file from the path from to path to, asynchronously.

The copy will fail if the destination already exists.

Parameters
- from: string
- to: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2329
Copy a file from the path from to path to, asynchronously.

Parameters
- from: string
- to: string
- options: CopyOptions
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2334
Copy a file from the path from to path to, asynchronously.

Parameters
- from: string
- to: string
- options: CopyOptions
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

copyBlocking

copyBlocking(from: string, to: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2339
Blocking version of {@link FileSystem#copy}

Parameters
- from: string
- to: string
Returns FileSystem

copyRecursive

copyRecursive(from: string, to: string, recursive: boolean): PromiseLike<void>
copyRecursive(from: string, to: string, recursive: boolean, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2349
Copy a file from the path from to path to, asynchronously.

If recursive is true and from represents a directory, then the directory and its contents will be copied recursively to the destination to.
The copy will fail if the destination if the destination already exists.

Parameters
- from: string
- to: string
- recursive: boolean
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2359
Copy a file from the path from to path to, asynchronously.

If recursive is true and from represents a directory, then the directory and its contents will be copied recursively to the destination to.
The copy will fail if the destination if the destination already exists.

Parameters
- from: string
- to: string
- recursive: boolean
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

copyRecursiveBlocking

copyRecursiveBlocking(from: string, to: string, recursive: boolean): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2364
Blocking version of {@link FileSystem#copyRecursive}

Parameters
- from: string
- to: string
- recursive: boolean
Returns FileSystem

createFile

createFile(path: string): PromiseLike<void>
createFile(path: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem
createFile(path: string, perms: string): PromiseLike<void>
createFile(path: string, perms: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2808
Creates an empty file with the specified path, asynchronously.

Parameters
- path: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2813
Creates an empty file with the specified path, asynchronously.

Parameters
- path: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2823
Creates an empty file with the specified path and permissions perms, asynchronously.

Parameters
- path: string
- perms: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2828
Creates an empty file with the specified path and permissions perms, asynchronously.

Parameters
- path: string
- perms: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

createFileBlocking

createFileBlocking(path: string): FileSystem
createFileBlocking(path: string, perms: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2818
Blocking version of {@link FileSystem#createFile}

Parameters
- path: string
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2833
Blocking version of {@link FileSystem#createFile}

Parameters
- path: string
- perms: string
Returns FileSystem

createTempDirectory

createTempDirectory(prefix: string): PromiseLike<string>
createTempDirectory(prefix: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem
createTempDirectory(prefix: string, perms: string): PromiseLike<string>
createTempDirectory(prefix: string, perms: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem
createTempDirectory(dir: string, prefix: string, perms: string): PromiseLike<string>
createTempDirectory(dir: string, prefix: string, perms: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2875
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- prefix: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2887
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- prefix: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2909
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- prefix: string
- perms: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2926
Creates a new directory in the default temporary-file directory, using the given prefix to generate its name, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- prefix: string
- perms: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2948
Creates a new directory in the directory provided by the path path, using the given prefix to generate its name, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- dir: string
- prefix: string
- perms: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2965
Creates a new directory in the directory provided by the path path, using the given prefix to generate its name, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- dir: string
- prefix: string
- perms: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem

createTempDirectoryBlocking

createTempDirectoryBlocking(prefix: string): string
createTempDirectoryBlocking(prefix: string, perms: string): string
createTempDirectoryBlocking(dir: string, prefix: string, perms: string): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2892
Blocking version of {@link FileSystem#createTempDirectory}

Parameters
- prefix: string
Returns string
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2931
Blocking version of {@link FileSystem#createTempDirectory}

Parameters
- prefix: string
- perms: string
Returns string
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2970
Blocking version of {@link FileSystem#createTempDirectory}

Parameters
- dir: string
- prefix: string
- perms: string
Returns string

createTempFile

createTempFile(prefix: string, suffix: string): PromiseLike<string>
createTempFile(prefix: string, suffix: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem
createTempFile(prefix: string, suffix: string, perms: string): PromiseLike<string>
createTempFile(prefix: string, suffix: string, perms: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem
createTempFile(dir: string, prefix: string, suffix: string, perms: string): PromiseLike<string>
createTempFile(dir: string, prefix: string, suffix: string, perms: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2982
Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- prefix: string
- suffix: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2994
Creates a new file in the default temporary-file directory, using the given prefix and suffix to generate its name, asynchronously.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- prefix: string
- suffix: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3011
Creates a new file in the directory provided by the path dir, using the given prefix and suffix to generate its name, asynchronously.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- prefix: string
- suffix: string
- perms: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3023
Creates a new file in the directory provided by the path dir, using the given prefix and suffix to generate its name, asynchronously.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- prefix: string
- suffix: string
- perms: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3045
Creates a new file in the directory provided by the path dir, using the given prefix and suffix to generate its name, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- dir: string
- prefix: string
- suffix: string
- perms: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3062
Creates a new file in the directory provided by the path dir, using the given prefix and suffix to generate its name, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.

As with the File.createTempFile methods, this method is only part of a temporary-file facility.A #addShutdownHook shutdown-hook, or the deleteOnExit mechanism may be used to delete the directory automatically.

Parameters
- dir: string
- prefix: string
- suffix: string
- perms: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem

createTempFileBlocking

createTempFileBlocking(prefix: string, suffix: string): string
createTempFileBlocking(prefix: string, suffix: string, perms: string): string
createTempFileBlocking(dir: string, prefix: string, suffix: string, perms: string): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2999
Blocking version of {@link FileSystem#createTempFile}

Parameters
- prefix: string
- suffix: string
Returns string
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3028
Blocking version of {@link FileSystem#createTempFile}

Parameters
- prefix: string
- suffix: string
- perms: string
Returns string
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:3067
Blocking version of {@link FileSystem#createTempFile}

Parameters
- dir: string
- prefix: string
- suffix: string
- perms: string
Returns string

delete

delete(path: string): PromiseLike<void>
delete(path: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2577
Deletes the file represented by the specified path, asynchronously.

Parameters
- path: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2582
Deletes the file represented by the specified path, asynchronously.

Parameters
- path: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

deleteBlocking

deleteBlocking(path: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2587
Blocking version of {@link FileSystem#delete}

Parameters
- path: string
Returns FileSystem

deleteRecursive

deleteRecursive(path: string, recursive: boolean): PromiseLike<void>
deleteRecursive(path: string, recursive: boolean, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2595
Deletes the file represented by the specified path, asynchronously.

If the path represents a directory and recursive = true then the directory and its contents will be deleted recursively.

Parameters
- path: string
- recursive: boolean
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2603
Deletes the file represented by the specified path, asynchronously.

If the path represents a directory and recursive = true then the directory and its contents will be deleted recursively.

Parameters
- path: string
- recursive: boolean
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

deleteRecursiveBlocking

deleteRecursiveBlocking(path: string, recursive: boolean): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2608
Blocking version of {@link FileSystem#deleteRecursive}

Parameters
- path: string
- recursive: boolean
Returns FileSystem

exists

exists(path: string): PromiseLike<boolean>
exists(path: string, handler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2838
Determines whether the file as specified by the path path exists, asynchronously.

Parameters
- path: string
Returns PromiseLike<boolean>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2843
Determines whether the file as specified by the path path exists, asynchronously.

Parameters
- path: string
- handler: ((res: AsyncResult<boolean>) => void) | Handler<AsyncResult<boolean>>
Returns FileSystem

existsBlocking

existsBlocking(path: string): boolean

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2848
Blocking version of {@link FileSystem#exists}

Parameters
- path: string
Returns boolean

fsProps

fsProps(path: string): PromiseLike<FileSystemProps>
fsProps(path: string, handler: ((res: AsyncResult<FileSystemProps>) => void) | Handler<AsyncResult<FileSystemProps>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2853
Returns properties of the file-system being used by the specified path, asynchronously.

Parameters
- path: string
Returns PromiseLike<FileSystemProps>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2858
Returns properties of the file-system being used by the specified path, asynchronously.

Parameters
- path: string
- handler: ((res: AsyncResult<FileSystemProps>) => void) | Handler<AsyncResult<FileSystemProps>>
Returns FileSystem

fsPropsBlocking

fsPropsBlocking(path: string): FileSystemProps

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2863
Blocking version of {@link FileSystem#fsProps}

Parameters
- path: string
Returns FileSystemProps

link

link(link: string, existing: string): PromiseLike<void>
link(link: string, existing: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2517
Create a hard link on the file system from link to existing, asynchronously.

Parameters
- link: string
- existing: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2522
Create a hard link on the file system from link to existing, asynchronously.

Parameters
- link: string
- existing: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

linkBlocking

linkBlocking(link: string, existing: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2527
Blocking version of {@link FileSystem#link}

Parameters
- link: string
- existing: string
Returns FileSystem

lprops

lprops(path: string): PromiseLike<FileProps>
lprops(path: string, handler: ((res: AsyncResult<FileProps>) => void) | Handler<AsyncResult<FileProps>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2500
Obtain properties for the link represented by path, asynchronously.

The link will not be followed.

Parameters
- path: string
Returns PromiseLike<FileProps>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2507
Obtain properties for the link represented by path, asynchronously.

The link will not be followed.

Parameters
- path: string
- handler: ((res: AsyncResult<FileProps>) => void) | Handler<AsyncResult<FileProps>>
Returns FileSystem

lpropsBlocking

lpropsBlocking(path: string): FileProps

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2512
Blocking version of {@link FileSystem#lprops}

Parameters
- path: string
Returns FileProps

mkdir

mkdir(path: string): PromiseLike<void>
mkdir(path: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem
mkdir(path: string, perms: string): PromiseLike<void>
mkdir(path: string, perms: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2615
Create the directory represented by path, asynchronously.

The operation will fail if the directory already exists.

Parameters
- path: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2622
Create the directory represented by path, asynchronously.

The operation will fail if the directory already exists.

Parameters
- path: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2639
Create the directory represented by path, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the directory already exists.

Parameters
- path: string
- perms: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2651
Create the directory represented by path, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the directory already exists.

Parameters
- path: string
- perms: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

mkdirBlocking

mkdirBlocking(path: string): FileSystem
mkdirBlocking(path: string, perms: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2627
Blocking version of {@link FileSystem#mkdir}

Parameters
- path: string
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2656
Blocking version of {@link FileSystem#mkdir}

Parameters
- path: string
- perms: string
Returns FileSystem

mkdirs

mkdirs(path: string): PromiseLike<void>
mkdirs(path: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem
mkdirs(path: string, perms: string): PromiseLike<void>
mkdirs(path: string, perms: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2663
Create the directory represented by path and any non existent parents, asynchronously.

The operation will fail if the path already exists but is not a directory.

Parameters
- path: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2670
Create the directory represented by path and any non existent parents, asynchronously.

The operation will fail if the path already exists but is not a directory.

Parameters
- path: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2687
Create the directory represented by path and any non existent parents, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the path already exists but is not a directory.

Parameters
- path: string
- perms: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2699
Create the directory represented by path and any non existent parents, asynchronously.

The new directory will be created with permissions as specified by perms.
The permission String takes the form rwxr-x--- as specified in here.
The operation will fail if the path already exists but is not a directory.

Parameters
- path: string
- perms: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

mkdirsBlocking

mkdirsBlocking(path: string): FileSystem
mkdirsBlocking(path: string, perms: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2675
Blocking version of {@link FileSystem#mkdirs}

Parameters
- path: string
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2704
Blocking version of {@link FileSystem#mkdirs}

Parameters
- path: string
- perms: string
Returns FileSystem

move

move(from: string, to: string): PromiseLike<void>
move(from: string, to: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem
move(from: string, to: string, options: CopyOptions): PromiseLike<void>
move(from: string, to: string, options: CopyOptions, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2371
Move a file from the path from to path to, asynchronously.

The move will fail if the destination already exists.

Parameters
- from: string
- to: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2378
Move a file from the path from to path to, asynchronously.

The move will fail if the destination already exists.

Parameters
- from: string
- to: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2383
Move a file from the path from to path to, asynchronously.

Parameters
- from: string
- to: string
- options: CopyOptions
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2388
Move a file from the path from to path to, asynchronously.

Parameters
- from: string
- to: string
- options: CopyOptions
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

moveBlocking

moveBlocking(from: string, to: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2393
Blocking version of {@link FileSystem#move}

Parameters
- from: string
- to: string
Returns FileSystem

open

open(path: string, options: OpenOptions): PromiseLike<AsyncFile>
open(path: string, options: OpenOptions, handler: ((res: AsyncResult<AsyncFile>) => void) | Handler<AsyncResult<AsyncFile>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2791
Open the file represented by path, asynchronously.

The file is opened for both reading and writing. If the file does not already exist it will be created.

Parameters
- path: string
- options: OpenOptions
Returns PromiseLike<AsyncFile>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2798
Open the file represented by path, asynchronously.

The file is opened for both reading and writing. If the file does not already exist it will be created.

Parameters
- path: string
- options: OpenOptions
- handler: ((res: AsyncResult<AsyncFile>) => void) | Handler<AsyncResult<AsyncFile>>
Returns FileSystem

openBlocking

openBlocking(path: string, options: OpenOptions): AsyncFile

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2803
Blocking version of {@link FileSystem#open}

Parameters
- path: string
- options: OpenOptions
Returns AsyncFile

props

props(path: string): PromiseLike<FileProps>
props(path: string, handler: ((res: AsyncResult<FileProps>) => void) | Handler<AsyncResult<FileProps>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2481
Obtain properties for the file represented by path, asynchronously.

If the file is a link, the link will be followed.

Parameters
- path: string
Returns PromiseLike<FileProps>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2488
Obtain properties for the file represented by path, asynchronously.

If the file is a link, the link will be followed.

Parameters
- path: string
- handler: ((res: AsyncResult<FileProps>) => void) | Handler<AsyncResult<FileProps>>
Returns FileSystem

propsBlocking

propsBlocking(path: string): FileProps

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2493
Blocking version of {@link FileSystem#props}

Parameters
- path: string
Returns FileProps

readDir

readDir(path: string): PromiseLike<string>
readDir(path: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem
readDir(path: string, filter: string): PromiseLike<string>
readDir(path: string, filter: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2711
Read the contents of the directory specified by path, asynchronously.

The result is an array of String representing the paths of the files inside the directory.

Parameters
- path: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2718
Read the contents of the directory specified by path, asynchronously.

The result is an array of String representing the paths of the files inside the directory.

Parameters
- path: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2733
Read the contents of the directory specified by path, asynchronously.

The parameter filter is a regular expression. If filter is specified then only the paths that match @{filter}will be returned.
The result is an array of String representing the paths of the files inside the directory.

Parameters
- path: string
- filter: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2743
Read the contents of the directory specified by path, asynchronously.

The parameter filter is a regular expression. If filter is specified then only the paths that match @{filter}will be returned.
The result is an array of String representing the paths of the files inside the directory.

Parameters
- path: string
- filter: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem

readDirBlocking

readDirBlocking(path: string): string
readDirBlocking(path: string, filter: string): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2723
Blocking version of {@link FileSystem#readDir}

Parameters
- path: string
Returns string
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2748
Blocking version of {@link FileSystem#readDir}

Parameters
- path: string
- filter: string
Returns string

readFile

readFile(path: string): PromiseLike<Buffer>
readFile(path: string, handler: ((res: AsyncResult<Buffer>) => void) | Handler<AsyncResult<Buffer>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2755
Reads the entire file as represented by the path path as a , asynchronously.

Do not use this method to read very large files or you risk running out of available RAM.

Parameters
- path: string
Returns PromiseLike<Buffer>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2762
Reads the entire file as represented by the path path as a , asynchronously.

Do not use this method to read very large files or you risk running out of available RAM.

Parameters
- path: string
- handler: ((res: AsyncResult<Buffer>) => void) | Handler<AsyncResult<Buffer>>
Returns FileSystem

readFileBlocking

readFileBlocking(path: string): Buffer

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2767
Blocking version of {@link FileSystem#readFile}

Parameters
- path: string
Returns Buffer

readSymlink

readSymlink(link: string): PromiseLike<string>
readSymlink(link: string, handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2562
Returns the path representing the file that the symbolic link specified by link points to, asynchronously.

Parameters
- link: string
Returns PromiseLike<string>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2567
Returns the path representing the file that the symbolic link specified by link points to, asynchronously.

Parameters
- link: string
- handler: ((res: AsyncResult<string>) => void) | Handler<AsyncResult<string>>
Returns FileSystem

readSymlinkBlocking

readSymlinkBlocking(link: string): string

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2572
Blocking version of {@link FileSystem#readSymlink}

Parameters
- link: string
Returns string

symlink

symlink(link: string, existing: string): PromiseLike<void>
symlink(link: string, existing: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2532
Create a symbolic link on the file system from link to existing, asynchronously.

Parameters
- link: string
- existing: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2537
Create a symbolic link on the file system from link to existing, asynchronously.

Parameters
- link: string
- existing: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

symlinkBlocking

symlinkBlocking(link: string, existing: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2542
Blocking version of {@link FileSystem#link}

Parameters
- link: string
- existing: string
Returns FileSystem

truncate

truncate(path: string, len: number): PromiseLike<void>
truncate(path: string, len: number, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2400
Truncate the file represented by path to length len in bytes, asynchronously.

The operation will fail if the file does not exist or len is less than zero.

Parameters
- path: string
- len: number
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2407
Truncate the file represented by path to length len in bytes, asynchronously.

The operation will fail if the file does not exist or len is less than zero.

Parameters
- path: string
- len: number
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

truncateBlocking

truncateBlocking(path: string, len: number): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2412
Blocking version of {@link FileSystem#truncate}

Parameters
- path: string
- len: number
Returns FileSystem

unlink

unlink(link: string): PromiseLike<void>
unlink(link: string, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2547
Unlinks the link on the file system represented by the path link, asynchronously.

Parameters
- link: string
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2552
Unlinks the link on the file system represented by the path link, asynchronously.

Parameters
- link: string
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

unlinkBlocking

unlinkBlocking(link: string): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2557
Blocking version of {@link FileSystem#unlink}

Parameters
- link: string
Returns FileSystem

writeFile

writeFile(path: string, data: Buffer): PromiseLike<void>
writeFile(path: string, data: Buffer, handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2773
Creates the file, and writes the specified Buffer data to the file represented by the path path, asynchronously.

Parameters
- path: string
- data: Buffer
Returns PromiseLike<void>
- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2779
Creates the file, and writes the specified Buffer data to the file represented by the path path, asynchronously.

Parameters
- path: string
- data: Buffer
- handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>
Returns FileSystem

writeFileBlocking

writeFileBlocking(path: string, data: Buffer): FileSystem

- Defined in generator/io.vertx/vertx-core/target/npm/index.d.ts:2784
Blocking version of {@link FileSystem#writeFile}

Parameters
- path: string
- data: Buffer
Returns FileSystem

Hierarchy

Index

Methods

Methods

chmod

Parameters

path: string

perms: string

Returns PromiseLike<void>

Parameters

path: string

perms: string

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns FileSystem

chmodBlocking

Parameters

path: string

perms: string

Returns FileSystem

chmodRecursive

Parameters

path: string

perms: string

dirPerms: string

Returns PromiseLike<void>

Parameters

path: string

perms: string

dirPerms: string

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns FileSystem

chmodRecursiveBlocking

Parameters

path: string

perms: string

dirPerms: string

Returns FileSystem

chown

Parameters

path: string

user: string | null | undefined

group: string | null | undefined

Returns PromiseLike<void>

Parameters

path: string

user: string | null | undefined

group: string | null | undefined

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns FileSystem

chownBlocking

Parameters

path: string

user: string | null | undefined

group: string | null | undefined

Returns FileSystem

copy

Parameters

from: string

to: string

Returns PromiseLike<void>

Parameters

from: string

to: string

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns FileSystem

Parameters

from: string

to: string

options: CopyOptions

Returns PromiseLike<void>

Parameters

from: string

to: string

options: CopyOptions

handler: ((res: AsyncResult<void>) => void) | Handler<AsyncResult<void>>

Returns FileSystem

copyBlocking

Parameters

from: string

to: string