[thorium-store-context](README.md) / Exports

# thorium-store-context

## Table of contents

### Interfaces

- [IStoreContext](interfaces/IStoreContext.md)
- [IStoreContextAPI](interfaces/IStoreContextAPI.md)
- [IStoreState](interfaces/IStoreState.md)
- [StoreContextOptions](interfaces/StoreContextOptions.md)

### Type Aliases

- [TStoreContext](modules.md#tstorecontext)
- [TStoreContextEvent](modules.md#tstorecontextevent)
- [TStoreStateToken](modules.md#tstorestatetoken)
- [TStoreUUID](modules.md#tstoreuuid)

### Functions

- [StoreContextFactory](modules.md#storecontextfactory)
- [applicationContext](modules.md#applicationcontext)
- [createStoreContext](modules.md#createstorecontext)
- [deleteStoreContext](modules.md#deletestorecontext)
- [listContext](modules.md#listcontext)
- [pageContext](modules.md#pagecontext)
- [rootContext](modules.md#rootcontext)
- [storeContext](modules.md#storecontext)

## Type Aliases

### TStoreContext

Ƭ **TStoreContext**: [`IStoreContext`](interfaces/IStoreContext.md)

#### Defined in

[store-context.ts:699](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L699)

___

### TStoreContextEvent

Ƭ **TStoreContextEvent**: ``"add"`` \| ``"update"`` \| ``"delete"``

Le type `TStoreContextEvent` est une union de chaînes de caractères ('add', 'update', 'delete')
qui représente les événements possibles dans un contexte de magasin (store context). Ces événements
sont utilisés pour notifier les changements sur les données stockées dans le contexte du magasin.
Par exemple, lorsque de nouvelles données sont ajoutées ('add'), existantes sont mises à jour ('update'),
ou supprimées ('delete').

## Exemple :
```typescript
const event: TStoreContextEvent = 'add';
```

#### Defined in

[store-context.ts:80](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L80)

___

### TStoreStateToken

Ƭ **TStoreStateToken**: \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`

#### Defined in

[store-context.ts:4](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L4)

___

### TStoreUUID

Ƭ **TStoreUUID**: \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\`

#### Defined in

[store-context.ts:515](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L515)

## Functions

### StoreContextFactory

▸ **StoreContextFactory**(`contextName`, `options?`): `Object`

The `StoreContext` class is an implementation of the `IStoreContext` interface in TypeScript,
providing methods for managing a store of state values.

#### Parameters

| Name | Type |
| :------ | :------ |
| `contextName` | `string` |
| `options` | [`StoreContextOptions`](interfaces/StoreContextOptions.md) |

#### Returns

`Object`

| Name | Type |
| :------ | :------ |
| `store` | typeof `StoreContext` |
| `storeId` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` |

#### Defined in

[store-context.ts:339](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L339)

___

### applicationContext

▸ **applicationContext**(): `TState`\<[`IStoreContext`](interfaces/IStoreContext.md)\>

The above function returns the value of the appContextState.

#### Returns

`TState`\<[`IStoreContext`](interfaces/IStoreContext.md)\>

The appContextState.value is being returned.

#### Defined in

[app-context.ts:30](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/app-context.ts#L30)

___

### createStoreContext

▸ **createStoreContext**(`contextName`, `options?`): [`IStoreContext`](interfaces/IStoreContext.md)

Crée un nouveau contexte de magasin avec le nom spécifié et les options facultatives.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `contextName` | `string` | Le nom du contexte de magasin. |
| `options?` | [`StoreContextOptions`](interfaces/StoreContextOptions.md) | (Facultatif) Les options pour la création du contexte. |

#### Returns

[`IStoreContext`](interfaces/IStoreContext.md)

Le nouveau contexte de magasin créé.
## Example
```typescript
const newContext = storeContext().create("NouveauContext");
```

#### Defined in

[store-context.ts:529](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L529)

___

### deleteStoreContext

▸ **deleteStoreContext**(`storeUuid`): `boolean`

Supprime un contexte de magasin existant avec l'UUID spécifié.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `storeUuid` | \`$\{string}-$\{string}-$\{string}-$\{string}-$\{string}\` | L'UUID du contexte de magasin à supprimer. |

#### Returns

`boolean`

Vrai si le contexte de magasin a été supprimé avec succès, sinon faux.
## Example
```typescript
const uuidToDelete = "xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"; // Remplacez par l'UUID du contexte à supprimer.
const deleted = storeContext().delete(uuidToDelete);
```

#### Defined in

[store-context.ts:541](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L541)

___

### listContext

▸ **listContext**(): `void`

La fonction `listContext` affiche la liste des contextes de magasin sous forme de tableau dans la console. Elle extrait les valeurs de tous les contextes de magasin disponibles dans `StoreStack` et les affiche sous forme tabulaire.

#### Returns

`void`

#### Defined in

[store-context.ts:690](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L690)

___

### pageContext

▸ **pageContext**(): `TState`\<[`IStoreContext`](interfaces/IStoreContext.md)\>

The function returns the value of the page context state.

#### Returns

`TState`\<[`IStoreContext`](interfaces/IStoreContext.md)\>

The value of the `pageContextState.value` variable.

#### Defined in

[page-context.ts:34](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/page-context.ts#L34)

___

### rootContext

▸ **rootContext**(): `TState`\<[`IStoreContext`](interfaces/IStoreContext.md)\>

The function returns the value of the root context state.

#### Returns

`TState`\<[`IStoreContext`](interfaces/IStoreContext.md)\>

The value of the `rootContextState.value` variable is being returned.

#### Defined in

[root-context.ts:27](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/root-context.ts#L27)

___

### storeContext

▸ **storeContext**(): [`IStoreContextAPI`](interfaces/IStoreContextAPI.md)

La fonction `storeContext` retourne une instance de l'interface `IStoreContextAPI` qui permet d'interagir avec les contextes de magasin.

#### Returns

[`IStoreContextAPI`](interfaces/IStoreContextAPI.md)

#### Defined in

[store-context.ts:618](https://github.com/Odyssee-Software/thorium-store-context/blob/ea2755d/src/store-context.ts#L618)