lean-s3
    Preparing search index...

    Class S3File

    Index
    [custom] arrayBuffer blob bytes copyTo delete exists json slice stat stream text toString write

    • Parameters

      • Optional_depth: number
      • options: InspectOptions = {}

      Returns string

    • Copies this file to a new destination.

      Parameters

      • destination: string

        The destination path.

      • options: CopyObjectOptions = {}

        Options for the copy operation.

      Returns Promise<void>

    • Delete a file from the bucket.

      Parameters

      Returns Promise<void>

      // Simple delete
      await client.delete("old-file.txt");

      // With error handling
      try {
        await client.delete("file.dat");
        console.log("File deleted");
      } catch (err) {
        console.error("Delete failed:", err);
      }

    • Creates and returns a new S3File containing a subset of this S3File data.

      Parameters

      • Optionalstart: number

        The starting index.

      • Optionalend: number

        The ending index, exclusive.

      Returns S3File

    • Creates and returns a new S3File containing a subset of this S3File data.

      Parameters

      • Optionalstart: number

        The starting index.

      • Optionalend: number

        The ending index, exclusive.

      • OptionalcontentType: string

        The content-type for the new S3File.

      Returns S3File

    • Get the stat of a file in the bucket. Uses HEAD request to check existence.

      Parameters

      Returns Promise<S3Stat>

      Uses HeadObject.

      If the file does not exist or the server has some other issues.

      If the server returns an invalid response.

    text

    • Parameters

      • data: ByteSource
      • options: S3FileWriteOptions = {}
        • OptionalcontentLength?: number

          Size of the data in bytes. Only used when writing a stream (Readable), where the size cannot be known in advance. Some providers (e.g. AWS) reject uploads without a known content length.

        • Optionalsignal?: AbortSignal

          Signal to abort the request.

        • Optionaltype?: string

          Content-Type of the file.

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Methods