@firebolt-js/core-client 1.0.0-next.5

package/dist/docs/Metrics/index.md

@@ -0,0 +1,987 @@
+---
+title: Metrics
+---
+
+# Metrics Module
+
+---
+
+Version Metrics 1.0.0-next.5
+
+## Table of Contents
+
+- [Table of Contents](#table-of-contents)
+- [Usage](#usage)
+- [Overview](#overview)
+- [Methods](#methods)
+  - [appInfo](#appinfo)
+  - [error](#error)
+  - [event](#event)
+  - [mediaEnded](#mediaended)
+  - [mediaLoadStart](#medialoadstart)
+  - [mediaPause](#mediapause)
+  - [mediaPlay](#mediaplay)
+  - [mediaPlaying](#mediaplaying)
+  - [mediaRateChanged](#mediaratechanged)
+  - [mediaRenditionChanged](#mediarenditionchanged)
+  - [mediaSeeked](#mediaseeked)
+  - [mediaSeeking](#mediaseeking)
+  - [mediaWaiting](#mediawaiting)
+  - [page](#page)
+  - [ready](#ready)
+  - [signIn](#signin)
+  - [signOut](#signout)
+  - [startContent](#startcontent)
+  - [stopContent](#stopcontent)
+- [Types](#types)
+  - [ErrorType](#errortype)
+  - [MediaPosition](#mediaposition)
+
+## Usage
+
+To use the Metrics module, you can import it into your project from the Firebolt SDK:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+```
+
+## Overview
+
+Methods for sending metrics
+
+## Methods
+
+### appInfo
+
+Inform the platform about an app's build info.
+
+```typescript
+function appInfo(build: string): Promise<null>
+```
+
+Parameters:
+
+| Param   | Type     | Required | Description                      |
+| ------- | -------- | -------- | -------------------------------- |
+| `build` | `string` | true     | The build / version of this app. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send appInfo metric
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let result = await Metrics.appInfo('1.2.2')
+console.log(result)
+```
+
+Value of `result`:
+
+```javascript
+null
+```
+
+---
+
+### error
+
+Inform the platform of an error that has occurred in your app.
+
+```typescript
+function error(
+  type: ErrorType,
+  code: string,
+  description: string,
+  visible: boolean,
+  parameters: object,
+  agePolicy: AgePolicy,
+): Promise<boolean>
+```
+
+Parameters:
+
+| Param         | Type                                          | Required | Description                                                                                                              |
+| ------------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `type`        | [`ErrorType`](#errortype)                     | true     | The type of error <br/>values: `'network' \| 'media' \| 'restriction' \| 'entitlement' \| 'other'`                       |
+| `code`        | `string`                                      | true     | an app-specific error code                                                                                               |
+| `description` | `string`                                      | true     | A short description of the error                                                                                         |
+| `visible`     | `boolean`                                     | true     | Whether or not this error was visible to the user.                                                                       |
+| `parameters`  | `object`                                      | false    | Optional additional parameters to be logged with the error                                                               |
+| `agePolicy`   | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send error metric
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.error(
+  'media',
+  'MEDIA-STALLED',
+  'playback stalled',
+  true,
+  undefined,
+)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### event
+
+Inform the platform of 1st party distributor metrics. 'data' parameter is a JSON document
+
+```typescript
+function event(
+  schema: string,
+  data: string,
+  agePolicy: AgePolicy,
+): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `schema`    | `string`                                      | true     | The schema URI of the metric type <br/>format: uri                                                                       |
+| `data`      | `string`                                      | true     | A JSON payload                                                                                                           |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                                  |
+| ---- | ------------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:distributor |
+
+#### Examples
+
+Send foo event
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let result = await Metrics.event(
+  'http://meta.rdkcentral.com/some/schema',
+  'foo',
+)
+console.log(result)
+```
+
+Value of `result`:
+
+```javascript
+true
+```
+
+---
+
+### mediaEnded
+
+Called when playback has stopped because the end of the media was reached.
+
+```typescript
+function mediaEnded(entityId: string, agePolicy: AgePolicy): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                               |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send ended metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaEnded('345')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaLoadStart
+
+Called when setting the URL of a media asset to play, in order to infer load time.
+
+```typescript
+function mediaLoadStart(
+  entityId: string,
+  agePolicy: AgePolicy,
+): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                               |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send loadstart metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaLoadStart('345')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaPause
+
+Called when media playback will pause due to an intentional pause operation.
+
+```typescript
+function mediaPause(entityId: string, agePolicy: AgePolicy): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                               |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send pause metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaPause('345')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaPlay
+
+Called when media playback should start due to autoplay, user-initiated play, or unpausing.
+
+```typescript
+function mediaPlay(entityId: string, agePolicy: AgePolicy): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                               |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send play metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaPlay('345')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaPlaying
+
+Called when media playback actually starts due to autoplay, user-initiated play, unpausing, or recovering from a buffering interruption.
+
+```typescript
+function mediaPlaying(entityId: string, agePolicy: AgePolicy): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                               |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send playing metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaPlaying('345')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaRateChanged
+
+Called when the playback rate of media is changed.
+
+```typescript
+function mediaRateChanged(
+  entityId: string,
+  rate: number,
+  agePolicy: AgePolicy,
+): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                               |
+| `rate`      | `number`                                      | true     | The new playback rate.                                                                                                   |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send ratechange metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaRateChanged('345', 2)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaRenditionChanged
+
+Called when the playback rendition (e.g. bitrate, dimensions, profile, etc) is changed.
+
+```typescript
+function mediaRenditionChanged(
+  entityId: string,
+  bitrate: number,
+  width: number,
+  height: number,
+  profile: string,
+  agePolicy: AgePolicy,
+): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                               |
+| `bitrate`   | `number`                                      | true     | The new bitrate in kbps.                                                                                                 |
+| `width`     | `number`                                      | true     | The new resolution width.                                                                                                |
+| `height`    | `number`                                      | true     | The new resolution height.                                                                                               |
+| `profile`   | `string`                                      | false    | A description of the new profile, e.g. 'HDR' etc.                                                                        |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send renditionchange metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaRenditionChanged(
+  '345',
+  5000,
+  1920,
+  1080,
+  'HDR+',
+)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaSeeked
+
+Called when a seek is completed during media playback.
+
+```typescript
+function mediaSeeked(
+  entityId: string,
+  position: MediaPosition,
+  agePolicy: AgePolicy,
+): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                                                                                                    |
+| ----------- | --------------------------------------------- | -------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                                                                                                     |
+| `position`  | [`MediaPosition`](#mediaposition)             | true     | Resulting position of the seek operation, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.                                                                       |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send seeked metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaSeeked('345', 0.51)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaSeeking
+
+Called when a seek is initiated during media playback.
+
+```typescript
+function mediaSeeking(
+  entityId: string,
+  target: MediaPosition,
+  agePolicy: AgePolicy,
+): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                                                                                          |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                                                                                           |
+| `target`    | [`MediaPosition`](#mediaposition)             | true     | Target destination of the seek, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration. |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed.                                                             |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send seeking metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaSeeking('345', 0.5)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### mediaWaiting
+
+Called when media playback will halt due to a network, buffer, or other unintentional constraint.
+
+```typescript
+function mediaWaiting(entityId: string, agePolicy: AgePolicy): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | true     | The entityId of the media.                                                                                               |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                            |
+| ---- | ------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:media |
+
+#### Examples
+
+Send waiting metric.
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.mediaWaiting('345')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### page
+
+Inform the platform that your user has navigated to a page or view.
+
+```typescript
+function page(pageId: string, agePolicy: AgePolicy): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `pageId`    | `string`                                      | true     | Page ID of the content.                                                                                                  |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send page metric
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.page('xyz')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+Send page metric w/ pageId
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.page('home')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### ready
+
+Inform the platform that your app is minimally usable. This method is called automatically by `Lifecycle.ready()`
+
+```typescript
+function ready(): Promise<boolean>
+```
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send ready metric
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.ready()
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### signIn
+
+_This is a private RPC method._
+
+Log a sign in event, called by Discovery.signIn().
+
+Result:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send signIn metric
+
+---
+
+### signOut
+
+_This is a private RPC method._
+
+Log a sign out event, called by Discovery.signOut().
+
+Result:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send signOut metric
+
+---
+
+### startContent
+
+Inform the platform that your user has started content.
+
+```typescript
+function startContent(entityId: string, agePolicy: AgePolicy): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | false    | Optional entity ID of the content.                                                                                       |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send startContent metric
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.startContent(undefined)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+Send startContent metric w/ entity
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.startContent('abc')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+Send startContent metric and notify the platform that the content is child-directed
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.startContent('abc', 'app:child')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+### stopContent
+
+Inform the platform that your user has stopped content.
+
+```typescript
+function stopContent(entityId: string, agePolicy: AgePolicy): Promise<boolean>
+```
+
+Parameters:
+
+| Param       | Type                                          | Required | Description                                                                                                              |
+| ----------- | --------------------------------------------- | -------- | ------------------------------------------------------------------------------------------------------------------------ |
+| `entityId`  | `string`                                      | false    | Optional entity ID of the content.                                                                                       |
+| `agePolicy` | [`AgePolicy`](../Policies/schemas/#AgePolicy) | false    | The age policy to associate with the metrics event. The age policy describes the age group to which content is directed. |
+
+Promise resolution:
+
+Capabilities:
+
+| Role | Capability                              |
+| ---- | --------------------------------------- |
+| uses | xrn:firebolt:capability:metrics:general |
+
+#### Examples
+
+Send stopContent metric
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.stopContent(undefined)
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+Send stopContent metric w/ entity
+
+JavaScript:
+
+```javascript
+import { Metrics } from '@firebolt-js/core-client'
+
+let success = await Metrics.stopContent('abc')
+console.log(success)
+```
+
+Value of `success`:
+
+```javascript
+true
+```
+
+---
+
+## Types
+
+### ErrorType
+
+```typescript
+ErrorType: {
+    NETWORK: 'network',
+    MEDIA: 'media',
+    RESTRICTION: 'restriction',
+    ENTITLEMENT: 'entitlement',
+    OTHER: 'other',
+},
+
+```
+
+---
+
+### MediaPosition
+
+Represents a position inside playback content, as a decimal percentage (0-0.999) for content with a known duration, or an integer number of seconds (0-86400) for content with an unknown duration.
+
+```typescript
+type MediaPosition = void | number | number
+```
+
+---