Tungsten

v0.1.0

Tungsten v0.1.0 Tungsten.CDP.IndexedDB View Source

IndexedDB

This domain has no documentation

Link to this section Summary

Types

cdp_data_entry_type()

IndexedDB.DataEntry

cdp_database_with_object_stores_type()

IndexedDB.DatabaseWithObjectStores

cdp_key_path_type()

IndexedDB.KeyPath

cdp_key_range_type()

IndexedDB.KeyRange

cdp_key_type()

IndexedDB.Key

cdp_object_store_index_type()

IndexedDB.ObjectStoreIndex

cdp_object_store_type()

IndexedDB.ObjectStore

Functions

clear_object_store(session, parameters, options \\ [])

IndexedDB.clearObjectStore

delete_database(session, parameters, options \\ [])

IndexedDB.deleteDatabase

delete_object_store_entries(session, parameters, options \\ [])

IndexedDB.deleteObjectStoreEntries

disable(session, parameters \\ %{}, options \\ [])

IndexedDB.disable

enable(session, parameters \\ %{}, options \\ [])

IndexedDB.enable

get_metadata(session, parameters, options \\ [])

IndexedDB.getMetadata

request_data(session, parameters, options \\ [])

IndexedDB.requestData

request_database(session, parameters, options \\ [])

IndexedDB.requestDatabase

request_database_names(session, parameters, options \\ [])

IndexedDB.requestDatabaseNames

Link to this section Types

Link to this type

cdp_data_entry_type() View Source 
cdp_data_entry_type() :: %{
  key: Tungsten.CDP.Runtime.cdp_remote_object_type(),
  primary_key: Tungsten.CDP.Runtime.cdp_remote_object_type(),
  value: Tungsten.CDP.Runtime.cdp_remote_object_type()
}

IndexedDB.DataEntry

Data entry.

Link to this type

cdp_database_with_object_stores_type() View Source 
cdp_database_with_object_stores_type() :: %{
  name: String.t(),
  version: integer() | float(),
  object_stores: [cdp_object_store_type()]
}

IndexedDB.DatabaseWithObjectStores

Database with an array of object stores.

Link to this type

cdp_key_path_type() View Source 
cdp_key_path_type() :: %{
  :type => :array | :string | :null,
  optional(:string) => String.t(),
  optional(:array) => [String.t()]
}

IndexedDB.KeyPath

Key path.

Link to this type

cdp_key_range_type() View Source 
cdp_key_range_type() :: %{
  optional(:lower) => cdp_key_type(),
  optional(:upper) => cdp_key_type(),
  :lower_open => boolean(),
  :upper_open => boolean()
}

IndexedDB.KeyRange

Key range.

Link to this type

cdp_key_type() View Source 
cdp_key_type() :: %{
  :type => :array | :date | :string | :number,
  optional(:number) => integer() | float(),
  optional(:string) => String.t(),
  optional(:date) => integer() | float(),
  optional(:array) => [cdp_key_type()]
}

IndexedDB.Key

Key.

Link to this type

cdp_object_store_index_type() View Source 
cdp_object_store_index_type() :: %{
  name: String.t(),
  key_path: cdp_key_path_type(),
  unique: boolean(),
  multi_entry: boolean()
}

IndexedDB.ObjectStoreIndex

Object store index.

Link to this type

cdp_object_store_type() View Source 
cdp_object_store_type() :: %{
  name: String.t(),
  key_path: cdp_key_path_type(),
  auto_increment: boolean(),
  indexes: [cdp_object_store_index_type()]
}

IndexedDB.ObjectStore

Object store.

Link to this section Functions

Link to this function

clear_object_store(session, parameters, options \\ []) View Source 
clear_object_store(
  GenServer.server(),
  %{
    security_origin: String.t(),
    database_name: String.t(),
    object_store_name: String.t()
  },
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

IndexedDB.clearObjectStore

Clears all entries from an object store.

Link to this function

delete_database(session, parameters, options \\ []) View Source 
delete_database(
  GenServer.server(),
  %{security_origin: String.t(), database_name: String.t()},
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

IndexedDB.deleteDatabase

Deletes a database.

Link to this function

delete_object_store_entries(session, parameters, options \\ []) View Source 
delete_object_store_entries(
  GenServer.server(),
  %{
    security_origin: String.t(),
    database_name: String.t(),
    object_store_name: String.t(),
    key_range: cdp_key_range_type()
  },
  Tungsten.Connection.exec_options()
) :: {:ok, map()} | {:error, term()}

IndexedDB.deleteObjectStoreEntries

Delete a range of entries from an object store

Link to this function

disable(session, parameters \\ %{}, options \\ []) View Source 
disable(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, map()} | {:error, term()}

IndexedDB.disable

Disables events from backend.

Link to this function

enable(session, parameters \\ %{}, options \\ []) View Source 
enable(GenServer.server(), map(), Tungsten.Connection.exec_options()) ::
  {:ok, map()} | {:error, term()}

IndexedDB.enable

Enables events from backend.

Link to this function

get_metadata(session, parameters, options \\ []) View Source 
get_metadata(
  GenServer.server(),
  %{
    security_origin: String.t(),
    database_name: String.t(),
    object_store_name: String.t()
  },
  Tungsten.Connection.exec_options()
) ::
  {:ok,
   %{
     entries_count: integer() | float(),
     key_generator_value: integer() | float()
   }}
  | {:error, term()}

IndexedDB.getMetadata

Gets metadata of an object store

Link to this function

request_data(session, parameters, options \\ []) View Source 
request_data(
  GenServer.server(),
  %{
    :security_origin => String.t(),
    :database_name => String.t(),
    :object_store_name => String.t(),
    :index_name => String.t(),
    :skip_count => integer(),
    :page_size => integer(),
    optional(:key_range) => cdp_key_range_type()
  },
  Tungsten.Connection.exec_options()
) ::
  {:ok,
   %{object_store_data_entries: [cdp_data_entry_type()], has_more: boolean()}}
  | {:error, term()}

IndexedDB.requestData

Requests data from object store or index.

Link to this function

request_database(session, parameters, options \\ []) View Source 
request_database(
  GenServer.server(),
  %{security_origin: String.t(), database_name: String.t()},
  Tungsten.Connection.exec_options()
) ::
  {:ok, %{database_with_object_stores: cdp_database_with_object_stores_type()}}
  | {:error, term()}

IndexedDB.requestDatabase

Requests database with given name in given frame.

Link to this function

request_database_names(session, parameters, options \\ []) View Source 
request_database_names(
  GenServer.server(),
  %{security_origin: String.t()},
  Tungsten.Connection.exec_options()
) :: {:ok, %{database_names: [String.t()]}} | {:error, term()}

IndexedDB.requestDatabaseNames

Requests database names for given security origin.