Skip to content
This repository was archived by the owner on Dec 7, 2022. It is now read-only.
This repository was archived by the owner on Dec 7, 2022. It is now read-only.

Roadmap for version 1.0 #87

@RomainLanz

Description

@RomainLanz

We are planning to release Flydrive version 1.0 soon. This will be a relatively huge release that include a number of necessary breaking changes.

The code of the release is currently in the next branch.

Planned Feature

Nice to have (could wait until after 1.0)

  • list(location: string)
  • copyToDisk(location: string, dest: string, destDisk: Storage)
  • moveToDisk(location: string, dest: string, destDisk: Storage)
  • getTimestamp(location: string)

Breaking Changes

No more FTP!

The FTP driver has been removed and will probably not be added again. Feel free to create you own driver and extend the manager with it.

No more proxies!

Proxies have been removed, that means we doesn't support magic method forwarding anymore. You will need to build an abstraction around it (like it's done in the Adonis implementation) if you want to keep this feature.

// Before
storage.exists(...)

// Now
storage.disk().exists(...)
storage.disk() // Returns the default disk (specified in the config)
storage.disk('awsCloud') // Returns the driver for the disk "awsCloud"
storage.disk('awsCloud', customConfig) // Overwrite the default configuration of the disk

Consistent returns/exceptions!

Since all drivers will have a consistent returns you will need to adapt your code to the new interface/abstraction we will create.

A good example is the put method that currently only return a boolean to give you insight if the file as been written or not.

However, some drivers like S3 return many information about the new file (#52). To avoid loosing those information we will create a common response object for those methods that will have always the same properties across all drivers.

If we don't handle a specific use case you will still be able to access the real response by using the raw property.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions