===========================================
MongoDB\\GridFS\\Bucket::downloadToStream()
===========================================

.. default-domain:: mongodb

.. contents:: On this page
   :local:
   :backlinks: none
   :depth: 1
   :class: singlecol

Definition
----------

.. phpmethod:: MongoDB\\GridFS\\Bucket::downloadToStreamByName()

   Selects a GridFS file by its ``filename`` and copies its contents to a
   writable stream.

   .. code-block:: php

      function downloadToStreamByName($filename, $destination, array $options = []): void

   This method has the following parameters:

   .. include:: /includes/apiargs/MongoDBGridFSBucket-method-downloadToStreamByName-param.rst

   The ``$options`` parameter supports the following options:

   .. include:: /includes/apiargs/MongoDBGridFSBucket-method-downloadToStreamByName-option.rst

.. todo: add examples

.. seealso::

   - :phpmethod:`MongoDB\\GridFS\\Bucket::downloadToStream()`
   - :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStream()`
   - :phpmethod:`MongoDB\\GridFS\\Bucket::openDownloadStreamByName()`
