Documentation Templates

Templates for documentation of apps.

App

# <APP NAME>

<APP DESCRIPTION>

## How to install

1. Install as developer dependency

    ```
    npm install -D <APP PACKAGE NAME>
    ```

2. Add app to your Alliance configuration file.

    ```ts
    // alliance.config.ts
    import { defineConfig } from '@telia-ace/alliance-framework/config';

    export default defineConfig({
        server: {
            apps: ['<APP PACKAGE NAME>'],
        },
    });
    ```

## Capabilities

No available capabilities.

## Managed Objects

No available managed objects.

Capability

### `<CAPABILITY>`

<CAPABILITY DESCRIPTION>

**Example**

```ts
// app.ts
import { runCapability } from '@telia-ace/alliance-framework';

runCapability('<APP>', '<CAPABILITY>', {
    <ARGS>
});
```

#### Args

| Property   | Type   | Required | Default       | Description |
| ---------- | ------ | -------- | ------------- | ----------- |
| `PROPERTY` | `TYPE` | REQUIRED | DEFAULT VALUE | DESCRIPTION |

#### Result

| Property   | Type   | Description |
| ---------- | ------ | ----------- |
| `PROPERTY` | `TYPE` | DESCRIPTION |

Managed object

### `<MANAGED OBJECT>`

<MANAGED OBJECT DESCRIPTION>

**Example**

```ts
// app.ts
import { queryObjects } from '@telia-ace/alliance-framework';

const query = queryObjects('<MANAGED OBJECT>', {
    <ARGS>
});

const objects = await query.resolve();

query.watch(async () => {
    const newObjects = await query.resolve();
});
```

#### Object Type

| Property   | Type   | Description |
| ---------- | ------ | ----------- |
| `PROPERTY` | `TYPE` | DESCRIPTION |

#### Query Args

| Property   | Type   | Required | Default       | Description |
| ---------- | ------ | -------- | ------------- | ----------- |
| `PROPERTY` | `TYPE` | REQUIRED | DEFAULT VALUE | DESCRIPTION |