Method findOne

src/collection.ts:542–555

(
    filter: Filter<TSchema> = {},
    options: Omit<FindOneOptions, 'timeoutMode'> & Abortable = {}
  )

  ): Promise<T | null>;

  async findOne(
    filter: Filter<TSchema> = {},
    options: Omit<FindOneOptions, 'timeoutMode'> & Abortable = {}
  ): Promise<WithId<TSchema> | null> {
    // Explicitly set the limit to 1 and singleBatch to true for all commands, per the spec.
    // noCursorTimeout must be unset as well as batchSize.
    // See: https://github.com/mongodb/specifications/blob/master/source/crud/crud.md#findone-api-details
    const { ...opts } = options;
    opts.singleBatch = true;
    const cursor = this.find(filter, opts).limit(1);
    const result = await cursor.next();
    await cursor.close();
    return result;
  }

  /**
   * Creates a cursor for a filter that can be used to iterate over results from MongoDB