Class Operator

See

For a detailed definition of scheme, see https://opendal.apache.org/docs/category/services

Append bytes into path.

Notes

• It always appends content to the end of the file.
• It will create file if the path not exists.

Example

await op.append("path/to/file", Buffer.from("hello world"));
// or
await op.append("path/to/file", "hello world");
Copy

Get current operator(service)'s full capability.

Check if this operator can work correctly.

We will send a list request to path and return any errors we met.

Example

await op.check();
Copy

Copy file according to given from and to path.

Example

await op.copy("path/to/file", "path/to/dest");
Copy

Copy file according to given from and to path synchronously.

Example

op.copySync("path/to/file", "path/to/dest");
Copy

Create dir with given path.

Example

await op.createDir("path/to/dir/");
Copy

Create dir with given path synchronously.

Example

op.createDirSync("path/to/dir/");
Copy

Delete the given path.

Notes

Delete not existing error won’t return errors.

Example

await op.delete("test");
Copy

Delete the given path synchronously.

Example

op.deleteSync("test");
Copy

Check if this path exists or not.

Example

await op.isExist("test");
Copy

Check if this path exists or not synchronously.

Example

op.isExistSync("test");
Copy

Add a layer to this operator.

List given path.

This function will return an array of entries.

An error will be returned if given path doesn't end with /.

Example

const list = await op.list("path/to/dir/");
for (let entry of list) {
  let meta = await op.stat(entry.path);
  if (meta.isFile) {
    // do something
  }
}
Copy

List recursively

With recursive option, you can list recursively.

const list = await op.list("path/to/dir/", { recursive: true });
for (let entry of list) {
  let meta = await op.stat(entry.path);
  if (meta.isFile) {
    // do something
  }
}
Copy

List given path synchronously.

This function will return a array of entries.

An error will be returned if given path doesn't end with /.

Example

const list = op.listSync("path/to/dir/");
for (let entry of list) {
  let meta = op.statSync(entry.path);
  if (meta.isFile) {
    // do something
  }
}
Copy

List recursively

With recursive option, you can list recursively.

const list = op.listSync("path/to/dir/", { recursive: true });
for (let entry of list) {
  let meta = op.statSync(entry.path);
  if (meta.isFile) {
    // do something
  }
}
Copy

Get a presigned request for read.

Unit of expires is seconds.

Example

const req = await op.presignRead(path, parseInt(expires));

console.log("method: ", req.method);
console.log("url: ", req.url);
console.log("headers: ", req.headers);
Copy

Get a presigned request for stat.

Unit of expires is seconds.

Example

const req = await op.presignStat(path, parseInt(expires));

console.log("method: ", req.method);
console.log("url: ", req.url);
console.log("headers: ", req.headers);
Copy

Get a presigned request for write.

Unit of expires is seconds.

Example

const req = await op.presignWrite(path, parseInt(expires));

console.log("method: ", req.method);
console.log("url: ", req.url);
console.log("headers: ", req.headers);
Copy

Read the whole path into a buffer.

Example

const buf = await op.read("path/to/file");
Copy

Read the whole path into a buffer synchronously.

Example

const buf = op.readSync("path/to/file");
Copy

Create a reader to read the given path.

It could be used to read large file in a streaming way.

Create a reader to read the given path synchronously.

It could be used to read large file in a streaming way.

Remove given paths.

Notes

If underlying services support delete in batch, we will use batch delete instead.

Examples

await op.remove(["abc", "def"]);
Copy

Remove the path and all nested dirs and files recursively.

Notes

If underlying services support delete in batch, we will use batch delete instead.

Examples

await op.removeAll("path/to/dir/");
Copy

Rename file according to given from and to path.

It's similar to mv command.

Example

await op.rename("path/to/file", "path/to/dest");
Copy

Rename file according to given from and to path synchronously.

It's similar to mv command.

Example

op.renameSync("path/to/file", "path/to/dest");
Copy

Get current path's metadata without cache directly.

Notes

Use stat if you:

• Want detect the outside changes of path.
• Don’t want to read from cached metadata.

You may want to use metadata if you are working with entries returned by Lister. It’s highly possible that metadata you want has already been cached.

Example

const meta = await op.stat("test");
if (meta.isDir) {
  // do something
}
Copy

Get current path's metadata without cache directly and synchronously.

Example

const meta = op.statSync("test");
if (meta.isDir) {
  // do something
}
Copy

Write bytes into path.

Example

await op.write("path/to/file", Buffer.from("hello world"));
// or
await op.write("path/to/file", "hello world");
Copy

Write bytes into path synchronously.

Example

op.writeSync("path/to/file", Buffer.from("hello world"));
// or
op.writeSync("path/to/file", "hello world");
Copy

Write multiple bytes into path.

It could be used to write large file in a streaming way.

Write multiple bytes into path synchronously.

It could be used to write large file in a streaming way.