Skip to content

Commit

Permalink
chore: Add some comments on storage symbols. (#938)
Browse files Browse the repository at this point in the history
Add some comments to Storage classes
  • Loading branch information
dshukertjr authored May 28, 2024
1 parent d562352 commit b25e41d
Showing 1 changed file with 15 additions and 5 deletions.
20 changes: 15 additions & 5 deletions packages/storage_client/lib/src/types.dart
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,17 @@ class BucketOptions {
}

class FileOptions {
/// The number of seconds the asset is cached in the browser and
/// in the Supabase CDN. This is set in the `Cache-Control: max-age=<seconds>`
/// header.
///
/// Defaults to `3600`.
final String cacheControl;

/// When upsert is set to true, the file is overwritten if it exists.
/// When set to false, an error is thrown if the object already exists.
///
/// Defaults to `false`.
final bool upsert;

/// Used as Content-Type
Expand All @@ -113,13 +123,13 @@ class FileOptions {
}

class SearchOptions {
/// The number of files you want to be returned. */
/// The number of files you want to be returned.
final int? limit;

/// The starting position. */
/// The starting position.
final int? offset;

/// The column to sort by. Can be any column inside a FileObject. */
/// The column to sort by. Can be any column inside a FileObject.
final SortBy? sortBy;

/// The search string to filter files by.
Expand Down Expand Up @@ -270,10 +280,10 @@ enum RequestImageFormat {
/// Specifies the dimensions and the resize mode of the requesting image.
/// {@endtemplate}
class TransformOptions {
/// Width of the requesting image to be.
/// The width of the image in pixels.
final int? width;

/// Height of requesting image to be.
/// The height of the image in pixels.
final int? height;

/// {@macro resize_mode}
Expand Down

0 comments on commit b25e41d

Please sign in to comment.