gflare - v1.0.0

gflare/kv

Types

GetOptions

</> 
pub type GetOptions {
  GetOptions(type_: String, cache_ttl: option.Option(Int))
}

Constructors

GetWithMetadataResult

</> 
pub type GetWithMetadataResult {
  GetWithMetadataResult(
    value: String,
    metadata: option.Option(dynamic.Dynamic),
  )
}

Constructors

Kv

</> 
pub type Kv

KvKey

</> 
pub type KvKey {
  KvKey(
    name: String,
    metadata: option.Option(dynamic.Dynamic),
    expiration: option.Option(Int),
  )
}

Constructors

ListOptions

</> 
pub type ListOptions {
  ListOptions(
    prefix: option.Option(String),
    cursor: option.Option(String),
    limit: option.Option(Int),
    reverse: option.Option(Bool),
  )
}

Constructors

ListResult

</> 
pub type ListResult {
  ListResult(
    keys: List(KvKey),
    list_complete: Bool,
    cursor: option.Option(String),
  )
}

Constructors

PutOptions

</> 
pub type PutOptions {
  PutOptions(
    expiration: option.Option(Int),
    expiration_ttl: option.Option(Int),
  )
}

Constructors

Values

delete

</> 
pub fn delete(
  namespace: Kv,
  key: String,
) -> promise.Promise(Result(Nil, error.Error))

get

</> 
pub fn get(
  namespace: Kv,
  key: String,
  options: GetOptions,
) -> promise.Promise(Result(String, error.Error))

get_options

</> 
pub fn get_options() -> GetOptions

get_options_with

</> 
pub fn get_options_with(
  type_ type_: String,
  cache_ttl ttl: option.Option(Int),
) -> GetOptions

get_with_metadata

</> 
pub fn get_with_metadata(
  namespace: Kv,
  key: String,
  options: GetOptions,
) -> promise.Promise(Result(GetWithMetadataResult, error.Error))

list

</> 
pub fn list(
  namespace: Kv,
  options: ListOptions,
) -> promise.Promise(Result(ListResult, error.Error))

list_options

</> 
pub fn list_options() -> ListOptions

put

</> 
pub fn put(
  namespace: Kv,
  key: String,
  value: String,
  options: PutOptions,
) -> promise.Promise(Result(Nil, error.Error))

put_options

</> 
pub fn put_options() -> PutOptions

put_options_with

</> 
pub fn put_options_with(
  expiration exp: option.Option(Int),
  expiration_ttl ttl: option.Option(Int),
) -> PutOptions
✨ Search Document