feat(module,app): basic module to list apps
This commit is contained in:
@ -20,6 +20,7 @@ function onInit() {
|
||||
|
||||
Listes des modules disponibles côté serveur.
|
||||
|
||||
- [`app`](./app.md)
|
||||
- [`auth`](./auth.md)
|
||||
- [`blob`](./blob.md)
|
||||
- [`cast`](./cast.md)
|
||||
|
57
doc/apps/server-api/app.md
Normal file
57
doc/apps/server-api/app.md
Normal file
@ -0,0 +1,57 @@
|
||||
# Module `app`
|
||||
|
||||
Ce module permet de récupérer des informations sur les applications actives dans l'environnement Edge courant.
|
||||
|
||||
## Méthodes
|
||||
|
||||
### `app.list(ctx: Context): []Manifest`
|
||||
|
||||
Récupère la liste des applications actives.
|
||||
|
||||
#### Arguments
|
||||
|
||||
- `ctx` **Context** Le contexte d'exécution. Voir la documentation du module [`context`](./context.md)
|
||||
|
||||
#### Valeur de retour
|
||||
|
||||
Liste des objets `Manifest` décrivant chaque application active.
|
||||
|
||||
### `app.get(ctx: Context, appId: string): Manifest`
|
||||
|
||||
Récupère les informations de l'application identifiée par `appId`.
|
||||
|
||||
#### Arguments
|
||||
|
||||
- `ctx` **Context** Le contexte d'exécution. Voir la documentation du module [`context`](./context.md)
|
||||
- `appId` **string** Identifiant de l'application
|
||||
|
||||
#### Valeur de retour
|
||||
|
||||
Objet `Manifest` associé à l'application, ou `null` si aucune application n'a été trouvée correspondant à l'identifiant.
|
||||
|
||||
### `app.getUrl(ctx: Context, appId: string): Manifest`
|
||||
|
||||
Retourne l'URL permettant d'accéder à l'application identifiée par `appId`.
|
||||
|
||||
#### Arguments
|
||||
|
||||
- `ctx` **Context** Le contexte d'exécution. Voir la documentation du module [`context`](./context.md)
|
||||
- `appId` **string** Identifiant de l'application
|
||||
|
||||
#### Valeur de retour
|
||||
|
||||
URL associée à l'application ou `null`, ou `null` si aucune application n'a été trouvée correspondant à l'identifiant.
|
||||
|
||||
## Objets
|
||||
|
||||
### `Manifest`
|
||||
|
||||
```typescript
|
||||
interface Manifest {
|
||||
id: string // Identifiant de l'application
|
||||
version: string // Version de l'application
|
||||
title: string // Titre associé à l'application
|
||||
description: string // Description associée à l'application
|
||||
tags: string[] // Mots clés associés à l'application
|
||||
}
|
||||
```
|
Reference in New Issue
Block a user