> ## Documentation Index
> Fetch the complete documentation index at: https://easyaf.nimbleapps.cloud/llms.txt
> Use this file to discover all available pages before exploring further.

# IndexedDbDatabase

> Provides functionality for accessing IndexedDB from Blazor application

## Definition

**Assembly:** CloudNimble.BlazorEssentials.IndexedDb.dll

**Namespace:** CloudNimble.BlazorEssentials.IndexedDb

**Inheritance:** System.Object

## Syntax

```csharp theme={"dark"}
CloudNimble.BlazorEssentials.IndexedDb.IndexedDbDatabase
```

## Summary

Provides functionality for accessing IndexedDB from Blazor application

## Constructors

###  .ctor

#### Syntax

```csharp theme={"dark"}
public IndexedDbDatabase(Microsoft.JSInterop.IJSRuntime jsRuntime)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `jsRuntime` | `Microsoft.JSInterop.IJSRuntime` | - |

###  .ctor Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public Object()
```

## Properties

###  DatabaseDefinition

#### Syntax

```csharp theme={"dark"}
public CloudNimble.BlazorEssentials.IndexedDb.Schema.IndexedDbDatabaseDefinition DatabaseDefinition { get; internal set; }
```

#### Property Value

Type: `CloudNimble.BlazorEssentials.IndexedDb.Schema.IndexedDbDatabaseDefinition`

###  Name

#### Syntax

```csharp theme={"dark"}
public string Name { get; init; }
```

#### Property Value

Type: `string`

###  ObjectStores

#### Syntax

```csharp theme={"dark"}
public System.Collections.Generic.List<CloudNimble.BlazorEssentials.IndexedDb.IndexedDbObjectStore> ObjectStores { get; private set; }
```

#### Property Value

Type: `System.Collections.Generic.List<CloudNimble.BlazorEssentials.IndexedDb.IndexedDbObjectStore>`

### &#x20;Version

#### Syntax

```csharp theme={"dark"}
public int Version { get; set; }
```

#### Property Value

Type: `int`

## Methods

### &#x20;CallJavaScriptAsync

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task CallJavaScriptAsync(string functionName, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `functionName` | `string` | - |
| `args` | `object[]` | - |

#### Returns

Type: `System.Threading.Tasks.Task`

#### Exceptions

| Exception | Description |
| - | - |
| `IndexedDbException` | |

### &#x20;CallJavaScriptAsync

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task<TResult> CallJavaScriptAsync<TResult>(string functionName, params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `functionName` | `string` | - |
| `args` | `object?[]` | - |

#### Returns

Type: `System.Threading.Tasks.Task<TResult>`

#### Type Parameters

* `TResult` -

#### Exceptions

| Exception | Description |
| - | - |
| `IndexedDbException` | |

### &#x20;ConsoleLog

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task ConsoleLog(params object[] args)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `args` | `object[]` | - |

#### Returns

Type: `System.Threading.Tasks.Task`

#### Exceptions

| Exception | Description |
| - | - |
| `IndexedDbException` | |

### &#x20;CreateObjectStoreAsync

This function provides the means to add a store to an existing database,

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task CreateObjectStoreAsync(CloudNimble.BlazorEssentials.IndexedDb.IndexedDbObjectStore objectStore)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objectStore` | `CloudNimble.BlazorEssentials.IndexedDb.IndexedDbObjectStore` | - |

#### Returns

Type: `System.Threading.Tasks.Task`

### &#x20;DeleteDatabaseAsync

Deletes this IndexedDb instance from the browser.

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task DeleteDatabaseAsync()
```

#### Returns

Type: `System.Threading.Tasks.Task`

### &#x20;EnsureIsOpenAsync

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task EnsureIsOpenAsync()
```

#### Returns

Type: `System.Threading.Tasks.Task`

### &#x20;Equals Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual bool Equals(object obj)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `obj` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;Equals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool Equals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;GetHashCode Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual int GetHashCode()
```

#### Returns

Type: `int`

### &#x20;GetType Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public System.Type GetType()
```

#### Returns

Type: `System.Type`

### &#x20;LoadSchemaAsync

Load database schema from databaseName

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task LoadSchemaAsync()
```

#### Returns

Type: `System.Threading.Tasks.Task`

### &#x20;MemberwiseClone Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
protected internal object MemberwiseClone()
```

#### Returns

Type: `object`

### &#x20;OpenAsync

Opens the IndexedDB defined in the DbDatabase. Under the covers will create the database if it does not exist
and create the stores defined in DbDatabase.

#### Syntax

```csharp theme={"dark"}
public System.Threading.Tasks.Task OpenAsync()
```

#### Returns

Type: `System.Threading.Tasks.Task`

### &#x20;ReferenceEquals Inherited

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public static bool ReferenceEquals(object objA, object objB)
```

#### Parameters

| Name | Type | Description |
| - | - | - |
| `objA` | `object?` | - |
| `objB` | `object?` | - |

#### Returns

Type: `bool`

### &#x20;ToString Inherited Virtual

> [!NOTE]
>
> Inherited from `object`

#### Syntax

```csharp theme={"dark"}
public virtual string ToString()
```

#### Returns

Type: `string?`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.