74 lines
1.5 KiB
Markdown
74 lines
1.5 KiB
Markdown
|
# Module `context`
|
||
|
|
|
||
|
|
Ce module permet de manipuler les informations de contexte liées à la réception de messages ou à l'utilisation de certains autres modules.
|
||
|
|
|
||
|
|
## Méthodes
|
||
|
|
|
||
|
|
### `context.new(): Context`
|
||
|
|
|
||
|
|
Renvoie un nouveau contexte vide.
|
||
|
|
|
||
|
|
#### Arguments
|
||
|
|
|
||
|
|
Aucun
|
||
|
|
#### Valeur de retour
|
||
|
|
|
||
|
|
Un nouvel objet de contexte.
|
||
|
|
|
||
|
|
#### Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
var ctx = context.new();
|
||
|
|
```
|
||
|
|
|
||
|
|
### `context.get(ctx: Context, key: string): any|null`
|
||
|
|
|
||
|
|
Récupère la valeur associée à la clé `key` dans le contexte si celle ci existe.
|
||
|
|
|
||
|
|
#### Arguments
|
||
|
|
|
||
|
|
- `ctx` **Context** Contexte duquel extraire la valeur souhaitée
|
||
|
|
- `key` **string** Clé associé à la valeur à récupérer
|
||
|
|
|
||
|
|
#### Valeur de retour
|
||
|
|
|
||
|
|
Valeur associée à la clé ou `null`.
|
||
|
|
|
||
|
|
#### Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
function onClientMessage(ctx, message) {
|
||
|
|
var sessionId = context.get(ctx, "mykey");
|
||
|
|
console.log(sessionId);
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
## Propriétés
|
||
|
|
|
||
|
|
### `context.SESSION_ID`
|
||
|
|
|
||
|
|
Clé permettant de récupérer la clé de session associé au client émetteur du message courant.
|
||
|
|
|
||
|
|
#### Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
function onClientMessage(ctx, message) {
|
||
|
|
var sessionId = context.get(ctx, context.SESSION_ID);
|
||
|
|
console.log(sessionId);
|
||
|
|
}
|
||
|
|
```
|
||
|
|
|
||
|
|
### `context.ORIGINAL_REQUEST`
|
||
|
|
|
||
|
|
Clé permettant de récupérer la requête HTTP à l'origine de la connexion du client.
|
||
|
|
|
||
|
|
_Cette propriété est utilisée par le module [`auth`](./auth.md) pour récupérer l'utilisateur associé au client._
|
||
|
|
|
||
|
|
#### Usage
|
||
|
|
|
||
|
|
```js
|
||
|
|
function onClientMessage(ctx, message) {
|
||
|
|
var request = context.get(ctx, context.ORIGINAL_REQUEST);
|
||
|
|
console.log(request);
|
||
|
|
}
|
||
|
|
```
|