Add isReady and isConfigured docs to APL section (#80)
This commit is contained in:
parent
bec148e696
commit
ed9c94299e
1 changed files with 28 additions and 0 deletions
28
docs/apl.md
28
docs/apl.md
|
@ -12,6 +12,34 @@ APL is an interface for managing auth data of registered Apps. Implementing it d
|
||||||
|
|
||||||
- `getAll: () => Promise<AuthData[]>` - Returns all auth data available.
|
- `getAll: () => Promise<AuthData[]>` - Returns all auth data available.
|
||||||
|
|
||||||
|
- `isReady: () => Promise<AplReadyResult>` - Check if persistence layer behind APL is ready. For example: database connection established
|
||||||
|
|
||||||
|
- `isConfigured: () => Promise<AplConfiguredResult>` - Check if persistence layer behind APL is configured. For example: env variable required by database connection
|
||||||
|
|
||||||
|
## AplReadyResult & ApConfiguredResult
|
||||||
|
|
||||||
|
Responses from `isReady()` and `isConfigured()` should match following:
|
||||||
|
|
||||||
|
```ts
|
||||||
|
type AplReadyResult =
|
||||||
|
| {
|
||||||
|
ready: true;
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
ready: false;
|
||||||
|
error: Error;
|
||||||
|
};
|
||||||
|
|
||||||
|
type AplConfiguredResult =
|
||||||
|
| {
|
||||||
|
configured: true;
|
||||||
|
}
|
||||||
|
| {
|
||||||
|
configured: false;
|
||||||
|
error: Error;
|
||||||
|
};
|
||||||
|
```
|
||||||
|
|
||||||
## Example implementation
|
## Example implementation
|
||||||
|
|
||||||
Let's create an APL, which uses Redis for data storage:
|
Let's create an APL, which uses Redis for data storage:
|
||||||
|
|
Loading…
Reference in a new issue