import type { ObjectId } from '../bson'; import type { Collection } from '../collection'; import type { FindCursor } from '../cursor/find_cursor'; import type { Db } from '../db'; import type { Logger } from '../logger'; import { Filter, TypedEventEmitter } from '../mongo_types'; import type { ReadPreference } from '../read_preference'; import { Callback } from '../utils'; import { WriteConcern, WriteConcernOptions } from '../write_concern'; import type { FindOptions } from './../operations/find'; import { GridFSBucketReadStream, GridFSBucketReadStreamOptions, GridFSBucketReadStreamOptionsWithRevision, GridFSFile } from './download'; import { GridFSBucketWriteStream, GridFSBucketWriteStreamOptions, GridFSChunk } from './upload'; /** @public */ export interface GridFSBucketOptions extends WriteConcernOptions { /** The 'files' and 'chunks' collections will be prefixed with the bucket name followed by a dot. */ bucketName?: string; /** Number of bytes stored in each chunk. Defaults to 255KB */ chunkSizeBytes?: number; /** Read preference to be passed to read operations */ readPreference?: ReadPreference; } /** @internal */ export interface GridFSBucketPrivate { db: Db; options: { bucketName: string; chunkSizeBytes: number; readPreference?: ReadPreference; writeConcern: WriteConcern | undefined; }; _chunksCollection: Collection; _filesCollection: Collection; checkedIndexes: boolean; calledOpenUploadStream: boolean; } /** @public */ export declare type GridFSBucketEvents = { index(): void; }; /** * Constructor for a streaming GridFS interface * @public */ export declare class GridFSBucket extends TypedEventEmitter { /** @internal */ s: GridFSBucketPrivate; /** * When the first call to openUploadStream is made, the upload stream will * check to see if it needs to create the proper indexes on the chunks and * files collections. This event is fired either when 1) it determines that * no index creation is necessary, 2) when it successfully creates the * necessary indexes. * @event */ static readonly INDEX: "index"; constructor(db: Db, options?: GridFSBucketOptions); /** * Returns a writable stream (GridFSBucketWriteStream) for writing * buffers to GridFS. The stream's 'id' property contains the resulting * file's id. * * @param filename - The value of the 'filename' key in the files doc * @param options - Optional settings. */ openUploadStream(filename: string, options?: GridFSBucketWriteStreamOptions): GridFSBucketWriteStream; /** * Returns a writable stream (GridFSBucketWriteStream) for writing * buffers to GridFS for a custom file id. The stream's 'id' property contains the resulting * file's id. */ openUploadStreamWithId(id: ObjectId, filename: string, options?: GridFSBucketWriteStreamOptions): GridFSBucketWriteStream; /** Returns a readable stream (GridFSBucketReadStream) for streaming file data from GridFS. */ openDownloadStream(id: ObjectId, options?: GridFSBucketReadStreamOptions): GridFSBucketReadStream; /** * Deletes a file with the given id * * @param id - The id of the file doc */ delete(id: ObjectId): Promise; delete(id: ObjectId, callback: Callback): void; /** Convenience wrapper around find on the files collection */ find(filter?: Filter, options?: FindOptions): FindCursor; /** * Returns a readable stream (GridFSBucketReadStream) for streaming the * file with the given name from GridFS. If there are multiple files with * the same name, this will stream the most recent file with the given name * (as determined by the `uploadDate` field). You can set the `revision` * option to change this behavior. */ openDownloadStreamByName(filename: string, options?: GridFSBucketReadStreamOptionsWithRevision): GridFSBucketReadStream; /** * Renames the file with the given _id to the given string * * @param id - the id of the file to rename * @param filename - new name for the file */ rename(id: ObjectId, filename: string): Promise; rename(id: ObjectId, filename: string, callback: Callback): void; /** Removes this bucket's files collection, followed by its chunks collection. */ drop(): Promise; drop(callback: Callback): void; /** Get the Db scoped logger. */ getLogger(): Logger; } //# sourceMappingURL=index.d.ts.map