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

# Interface: IStoreContextAPI

## Table of contents

### Methods

- [create](IStoreContextAPI.md#create)
- [delete](IStoreContextAPI.md#delete)
- [getChildrenContext](IStoreContextAPI.md#getchildrencontext)
- [getContextByHuid](IStoreContextAPI.md#getcontextbyhuid)
- [getContextById](IStoreContextAPI.md#getcontextbyid)
- [getContextByName](IStoreContextAPI.md#getcontextbyname)
- [getContextByUnId](IStoreContextAPI.md#getcontextbyunid)
- [getParentContext](IStoreContextAPI.md#getparentcontext)

## Methods

### create

▸ **create**(`contextName`, `options?`): [`IStoreContext`](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`](StoreContextOptions.md) | (Facultatif) Les options pour la création du contexte. |

#### Returns

[`IStoreContext`](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)

___

### delete

▸ **delete**(`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)

___

### getChildrenContext

▸ **getChildrenContext**(`storeHuid`): [`IStoreContext`](IStoreContext.md)[]

Récupère les contextes enfants d'un contexte de magasin par son HUID.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `storeHuid` | `_HUID` | L'HUID du contexte de magasin pour lequel vous souhaitez trouver les contextes enfants. |

#### Returns

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

Un tableau de contextes enfants correspondant à l'HUID.
## Example
```typescript
const huidToFindChildren = new _HUUID('xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'); // Remplacez par l'HUID du contexte parent.
const childrenContexts = storeContext().getChildrenContext(huidToFindChildren);
```

#### Defined in

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

___

### getContextByHuid

▸ **getContextByHuid**(`storeHuid`): [`IStoreContext`](IStoreContext.md)

Récupère un contexte de magasin par son HUID (Hierarchical Unique Identifier).

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `storeHuid` | `_HUID` | L'HUID du contexte de magasin à récupérer. |

#### Returns

[`IStoreContext`](IStoreContext.md)

Le contexte de magasin correspondant à l'HUID, ou null s'il n'existe pas.
## Example
```typescript
const huidToRetrieve = new _HUUID("xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx") // Remplacez par l'HUID du contexte à récupérer.
const retrievedContext = storeContext().getContextByHuid(huidToRetrieve);
```

#### Defined in

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

___

### getContextById

▸ **getContextById**(`storeUuid`): [`IStoreContext`](IStoreContext.md)

Récupère un contexte de magasin par son UUID.

#### Parameters

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

#### Returns

[`IStoreContext`](IStoreContext.md)

Le contexte de magasin correspondant à l'UUID, ou null s'il n'existe pas.
## Example
```typescript
const uuidToRetrieve = "xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"; // Remplacez par l'UUID du contexte à récupérer.
const retrievedContext = storeContext().getContextById(uuidToRetrieve);
```

#### Defined in

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

___

### getContextByName

▸ **getContextByName**(`contextName`): [`IStoreContext`](IStoreContext.md)[]

Récupère tous les contextes de magasin avec le nom spécifié.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `contextName` | `string` | Le nom des contextes de magasin à récupérer. |

#### Returns

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

Un tableau de tous les contextes de magasin correspondant au nom.
## Example
```typescript
const nameToRetrieve = "MyContext"; // Remplacez par le nom du contexte à récupérer.
const retrievedContexts = storeContext().getContextByName(nameToRetrieve);
```

#### Defined in

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

___

### getContextByUnId

▸ **getContextByUnId**(`storeUnid`): [`IStoreContext`](IStoreContext.md)

Récupère un contexte de magasin par son UNID (Unique Identifier).

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `storeUnid` | `string` | L'UNID du contexte de magasin à récupérer. |

#### Returns

[`IStoreContext`](IStoreContext.md)

Le contexte de magasin correspondant à l'UNID, ou null s'il n'existe pas.
## Example
```typescript
const unidToRetrieve = "xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx-MyContext"; // Remplacez par l'UNID du contexte à récupérer.
const retrievedContext = storeContext().getContextByUnid(unidToRetrieve);
```

#### Defined in

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

___

### getParentContext

▸ **getParentContext**(`storeHuid`): [`IStoreContext`](IStoreContext.md)

Récupère le contexte parent d'un contexte de magasin par son HUID.

#### Parameters

| Name | Type | Description |
| :------ | :------ | :------ |
| `storeHuid` | `_HUID` | L'HUID du contexte de magasin pour lequel vous souhaitez trouver le contexte parent. |

#### Returns

[`IStoreContext`](IStoreContext.md)

Le contexte parent correspondant à l'HUID, ou null s'il n'existe pas.
## Example
```typescript
const huidToFindParent = new _HUUID('xxxxxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx'); // Remplacez par l'HUID du contexte fils.
const parentContext = storeContext().getParentContext(huidToFindParent);
```

#### Defined in

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