Liking cljdoc? Tell your friends :D

supabase.storage.specs

Malli schemas for Supabase Storage operation inputs.

Schemas validate caller arguments only — response bodies are returned as plain JSON-decoded maps. See https://supabase.com/docs/reference/javascript/storage-createbucket

Malli schemas for Supabase Storage operation inputs.

Schemas validate caller arguments only — response bodies are returned as
plain JSON-decoded maps. See https://supabase.com/docs/reference/javascript/storage-createbucket
raw docstring

BucketCreateclj

Schema for create-bucket attributes. id is passed positionally and is not part of this map.

Schema for create-bucket attributes. `id` is passed positionally and is
not part of this map.
sourceraw docstring

BucketUpdateclj

Schema for update-bucket attributes.

Schema for update-bucket attributes.
sourceraw docstring

CreateIndexParamsclj

Schema for vector create-index params. vector-bucket-name comes from the instance and is not part of this map.

Schema for vector create-index params. `vector-bucket-name` comes from
the instance and is not part of this map.
sourceraw docstring

DownloadOptsclj

Schema for download options.

  • :response-as:byte-array (default) or :stream
  • :range[start end] byte range (inclusive) for partial downloads
  • :transform — image transformation options (renders via render/image)
  • :headers — extra request headers
Schema for download options.

* `:response-as` — `:byte-array` (default) or `:stream`
* `:range` — `[start end]` byte range (inclusive) for partial downloads
* `:transform` — image transformation options (renders via render/image)
* `:headers` — extra request headers
sourceraw docstring

ensure-storageclj

(ensure-storage s)

Returns nil if s is a valid storage instance, otherwise an anomaly.

Returns nil if `s` is a valid storage instance, otherwise an anomaly.
sourceraw docstring

ensure-validclj

(ensure-valid schema value)

Returns nil if value matches schema, otherwise an anomaly carrying the malli explanation.

Returns nil if `value` matches `schema`, otherwise an anomaly carrying
the malli explanation.
sourceraw docstring

ensure-vector-storageclj

(ensure-vector-storage v)

Returns nil if v is a valid vector storage instance, otherwise an anomaly.

Returns nil if `v` is a valid vector storage instance, otherwise an
anomaly.
sourceraw docstring

FileOptionsclj

Schema for upload/update options.

Schema for upload/update options.
sourceraw docstring

GetVectorsOptsclj

Schema for get-vectors options. keys is required.

Schema for get-vectors options. `keys` is required.
sourceraw docstring

ListIndexesOptsclj

Schema for vector list-indexes options. Same shape as ListVectorBucketsOpts.

Schema for vector list-indexes options. Same shape as
`ListVectorBucketsOpts`.
sourceraw docstring

ListV2Optionsclj

Schema for cursor-based list-v2 pagination options.

  • :limit — page size (default server-side 100)
  • :cursor — pagination cursor from a previous response
  • :with-delimiter — group by folder hierarchy when true
Schema for cursor-based list-v2 pagination options.

* `:limit` — page size (default server-side 100)
* `:cursor` — pagination cursor from a previous response
* `:with-delimiter` — group by folder hierarchy when true
sourceraw docstring

ListVectorBucketsOptsclj

Schema for vector list-buckets options. All fields optional.

Schema for vector list-buckets options. All fields optional.
sourceraw docstring

ListVectorsOptsclj

Schema for list-vectors options. All fields optional; when both :segment-count and :segment-index are given, the index must be within [0, segment-count).

Schema for list-vectors options. All fields optional; when both
`:segment-count` and `:segment-index` are given, the index must be
within `[0, segment-count)`.
sourceraw docstring

MoveCopyOptsclj

Schema for move/copy options.

Schema for move/copy options.
sourceraw docstring

PublicUrlOptsclj

Schema for get-public-url options.

Schema for get-public-url options.
sourceraw docstring

QueryVectorsQueryclj

Schema for query-vectors input. :query-vector is required.

Schema for query-vectors input. `:query-vector` is required.
sourceraw docstring

SearchOptionsclj

Schema for list-files search options. All fields optional.

Schema for list-files search options. All fields optional.
sourceraw docstring

SignedUploadOptsclj

Schema for create-signed-upload-url options.

Schema for create-signed-upload-url options.
sourceraw docstring

SignedUrlOptsclj

Schema for create-signed-url options. expires-in is required (seconds).

Schema for create-signed-url options. `expires-in` is required (seconds).
sourceraw docstring

SignedUrlsOptsclj

Schema for create-signed-urls options.

Schema for create-signed-urls options.
sourceraw docstring

SortByclj

source

Storageclj

Schema for a storage instance map produced by from.

Schema for a storage instance map produced by `from`.
sourceraw docstring

TransformOptionsclj

Schema for image transformation options applied on render.

  • :width / :height — target size in pixels
  • :resize"cover" (default), "contain", "fill"
  • :quality — 20–100 (default 80)
  • :format — e.g. "origin", "webp"
Schema for image transformation options applied on render.

* `:width` / `:height` — target size in pixels
* `:resize` — `"cover"` (default), `"contain"`, `"fill"`
* `:quality` — 20–100 (default 80)
* `:format` — e.g. `"origin"`, `"webp"`
sourceraw docstring

UploadBodyclj

Schema for upload body — bytes, InputStream, File, or string.

Schema for upload body — bytes, InputStream, File, or string.
sourceraw docstring

VectorBatchclj

Schema for put-vectors input: 1-500 API-shaped vector entries.

Schema for put-vectors input: 1-500 API-shaped vector entries.
sourceraw docstring

VectorKeysclj

Schema for delete-vectors input: 1-500 vector keys.

Schema for delete-vectors input: 1-500 vector keys.
sourceraw docstring

VectorStorageclj

Schema for a vector storage instance map produced by supabase.storage.vector/from and supabase.storage.vector/index. :vector-bucket-name is required by index operations and :vector-index-name additionally by vector data operations.

Schema for a vector storage instance map produced by
`supabase.storage.vector/from` and `supabase.storage.vector/index`.
`:vector-bucket-name` is required by index operations and
`:vector-index-name` additionally by vector data operations.
sourceraw docstring

cljdoc builds & hosts documentation for Clojure/Script libraries

Keyboard shortcuts
Ctrl+kJump to recent docs
Move to previous article
Move to next article
Ctrl+/Jump to the search field
× close