Skip to content

Commit

Permalink
docs: about npm scope
Browse files Browse the repository at this point in the history
  • Loading branch information
@pattan
pattan committed May 6, 2024
1 parent 9808e78 commit c6dc118
Show file tree
Hide file tree
Showing 27 changed files with 164 additions and 161 deletions.
34 changes: 17 additions & 17 deletions www/api/classes/advantage_advantage.Advantage.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[advantage](../index.md) / [advantage/advantage](../modules/advantage_advantage.md) / Advantage
[@get-advantage/advantage](../index.md) / [advantage/advantage](../modules/advantage_advantage.md) / Advantage

# Class: Advantage

Expand All @@ -18,7 +18,7 @@ The main class for the Advantage library. This class is a singleton and is used

#### Defined in

[src/advantage/advantage.ts:25](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L25)
[src/advantage/advantage.ts:25](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L25)

## Properties

Expand All @@ -28,7 +28,7 @@ The main class for the Advantage library. This class is a singleton and is used

#### Defined in

[src/advantage/advantage.ts:20](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L20)
[src/advantage/advantage.ts:20](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L20)

___

Expand All @@ -38,7 +38,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:17](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L17)
[src/advantage/advantage.ts:17](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L17)

___

Expand All @@ -48,7 +48,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:18](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L18)
[src/advantage/advantage.ts:18](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L18)

___

Expand All @@ -58,7 +58,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:22](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L22)
[src/advantage/advantage.ts:22](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L22)

___

Expand All @@ -68,7 +68,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:21](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L21)
[src/advantage/advantage.ts:21](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L21)

___

Expand All @@ -78,7 +78,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:19](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L19)
[src/advantage/advantage.ts:19](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L19)

___

Expand All @@ -88,7 +88,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:23](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L23)
[src/advantage/advantage.ts:23](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L23)

___

Expand All @@ -98,7 +98,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:16](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L16)
[src/advantage/advantage.ts:16](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L16)

## Methods

Expand All @@ -118,7 +118,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:76](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L76)
[src/advantage/advantage.ts:76](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L76)

___

Expand All @@ -138,7 +138,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:30](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L30)
[src/advantage/advantage.ts:30](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L30)

___

Expand All @@ -158,7 +158,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:64](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L64)
[src/advantage/advantage.ts:64](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L64)

___

Expand All @@ -179,7 +179,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:96](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L96)
[src/advantage/advantage.ts:96](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L96)

___

Expand All @@ -199,7 +199,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:49](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L49)
[src/advantage/advantage.ts:49](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L49)

___

Expand All @@ -219,7 +219,7 @@ ___

#### Defined in

[src/advantage/advantage.ts:43](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L43)
[src/advantage/advantage.ts:43](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L43)

___

Expand All @@ -233,4 +233,4 @@ ___

#### Defined in

[src/advantage/advantage.ts:55](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/advantage.ts#L55)
[src/advantage/advantage.ts:55](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/advantage.ts#L55)
16 changes: 8 additions & 8 deletions www/api/classes/advantage_messaging_creative_side.AdvantageCreativeMessenger.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[advantage](../index.md) / [advantage/messaging/creative-side](../modules/advantage_messaging_creative_side.md) / AdvantageCreativeMessenger
[@get-advantage/advantage](../index.md) / [advantage/messaging/creative-side](../modules/advantage_messaging_creative_side.md) / AdvantageCreativeMessenger

# Class: AdvantageCreativeMessenger

Expand Down Expand Up @@ -60,7 +60,7 @@ advantageMessenger.startSession().then((confirmed) => {

#### Defined in

[src/advantage/messaging/creative-side.ts:57](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/creative-side.ts#L57)
[src/advantage/messaging/creative-side.ts:57](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/creative-side.ts#L57)

## Properties

Expand All @@ -70,7 +70,7 @@ advantageMessenger.startSession().then((confirmed) => {

#### Defined in

[src/advantage/messaging/creative-side.ts:53](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/creative-side.ts#L53)
[src/advantage/messaging/creative-side.ts:53](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/creative-side.ts#L53)

___

Expand All @@ -80,7 +80,7 @@ ___

#### Defined in

[src/advantage/messaging/creative-side.ts:54](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/creative-side.ts#L54)
[src/advantage/messaging/creative-side.ts:54](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/creative-side.ts#L54)

___

Expand All @@ -90,7 +90,7 @@ ___

#### Defined in

[src/advantage/messaging/creative-side.ts:55](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/creative-side.ts#L55)
[src/advantage/messaging/creative-side.ts:55](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/creative-side.ts#L55)

## Methods

Expand All @@ -110,7 +110,7 @@ ___

#### Defined in

[src/advantage/messaging/creative-side.ts:99](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/creative-side.ts#L99)
[src/advantage/messaging/creative-side.ts:99](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/creative-side.ts#L99)

___

Expand All @@ -130,7 +130,7 @@ ___

#### Defined in

[src/advantage/messaging/creative-side.ts:78](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/creative-side.ts#L78)
[src/advantage/messaging/creative-side.ts:78](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/creative-side.ts#L78)

___

Expand All @@ -144,4 +144,4 @@ ___

#### Defined in

[src/advantage/messaging/creative-side.ts:61](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/creative-side.ts#L61)
[src/advantage/messaging/creative-side.ts:61](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/creative-side.ts#L61)
24 changes: 12 additions & 12 deletions www/api/classes/advantage_messaging_publisher_side.AdvantageAdSlotResponder.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[advantage](../index.md) / [advantage/messaging/publisher-side](../modules/advantage_messaging_publisher_side.md) / AdvantageAdSlotResponder
[@get-advantage/advantage](../index.md) / [advantage/messaging/publisher-side](../modules/advantage_messaging_publisher_side.md) / AdvantageAdSlotResponder

# Class: AdvantageAdSlotResponder

Expand Down Expand Up @@ -49,7 +49,7 @@ Constructs a new instance of the AdvantageAdSlotResponder, initializing it with
#### Defined in
[src/advantage/messaging/publisher-side.ts:53](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L53)
[src/advantage/messaging/publisher-side.ts:53](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L53)
## Properties
Expand All @@ -59,7 +59,7 @@ Constructs a new instance of the AdvantageAdSlotResponder, initializing it with
#### Defined in
[src/advantage/messaging/publisher-side.ts:32](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L32)
[src/advantage/messaging/publisher-side.ts:32](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L32)
___
Expand All @@ -69,7 +69,7 @@ ___
#### Defined in
[src/advantage/messaging/publisher-side.ts:41](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L41)
[src/advantage/messaging/publisher-side.ts:41](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L41)
___
Expand All @@ -79,7 +79,7 @@ ___
#### Defined in
[src/advantage/messaging/publisher-side.ts:39](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L39)
[src/advantage/messaging/publisher-side.ts:39](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L39)
___
Expand All @@ -89,7 +89,7 @@ ___
#### Defined in
[src/advantage/messaging/publisher-side.ts:40](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L40)
[src/advantage/messaging/publisher-side.ts:40](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L40)
___
Expand All @@ -99,7 +99,7 @@ ___
#### Defined in
[src/advantage/messaging/publisher-side.ts:33](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L33)
[src/advantage/messaging/publisher-side.ts:33](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L33)
___
Expand All @@ -109,7 +109,7 @@ ___
#### Defined in
[src/advantage/messaging/publisher-side.ts:44](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L44)
[src/advantage/messaging/publisher-side.ts:44](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L44)
## Methods
Expand All @@ -131,7 +131,7 @@ Checks if the message is from an ad that is already registered
#### Defined in
[src/advantage/messaging/publisher-side.ts:137](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L137)
[src/advantage/messaging/publisher-side.ts:137](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L137)
___
Expand All @@ -153,7 +153,7 @@ This method handles incoming messages from Advantage ads and processes them acco
#### Defined in
[src/advantage/messaging/publisher-side.ts:82](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L82)
[src/advantage/messaging/publisher-side.ts:82](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L82)
___
Expand All @@ -175,7 +175,7 @@ element is IAdvantageWrapper
#### Defined in
[src/advantage/messaging/publisher-side.ts:199](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L199)
[src/advantage/messaging/publisher-side.ts:199](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L199)
___
Expand All @@ -197,4 +197,4 @@ This method listens for incoming messages from Advantage ads and processes them
#### Defined in
[src/advantage/messaging/publisher-side.ts:148](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/messaging/publisher-side.ts#L148)
[src/advantage/messaging/publisher-side.ts:148](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/messaging/publisher-side.ts#L148)
18 changes: 9 additions & 9 deletions www/api/classes/advantage_ui_layer.AdvantageUILayer.md
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
[advantage](../index.md) / [advantage/ui-layer](../modules/advantage_ui_layer.md) / AdvantageUILayer
[@get-advantage/advantage](../index.md) / [advantage/ui-layer](../modules/advantage_ui_layer.md) / AdvantageUILayer

# Class: AdvantageUILayer

Expand Down Expand Up @@ -32,7 +32,7 @@ HTMLElement.constructor

#### Defined in

[src/advantage/ui-layer.ts:16](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/ui-layer.ts#L16)
[src/advantage/ui-layer.ts:16](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/ui-layer.ts#L16)

## Properties

Expand All @@ -42,7 +42,7 @@ HTMLElement.constructor

#### Defined in

[src/advantage/ui-layer.ts:9](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/ui-layer.ts#L9)
[src/advantage/ui-layer.ts:9](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/ui-layer.ts#L9)

___

Expand All @@ -52,7 +52,7 @@ ___

#### Defined in

[src/advantage/ui-layer.ts:10](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/ui-layer.ts#L10)
[src/advantage/ui-layer.ts:10](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/ui-layer.ts#L10)

___

Expand All @@ -62,7 +62,7 @@ ___

#### Defined in

[src/advantage/ui-layer.ts:7](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/ui-layer.ts#L7)
[src/advantage/ui-layer.ts:7](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/ui-layer.ts#L7)

___

Expand All @@ -72,7 +72,7 @@ ___

#### Defined in

[src/advantage/ui-layer.ts:8](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/ui-layer.ts#L8)
[src/advantage/ui-layer.ts:8](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/ui-layer.ts#L8)

___

Expand All @@ -82,7 +82,7 @@ ___

#### Defined in

[src/advantage/ui-layer.ts:11](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/ui-layer.ts#L11)
[src/advantage/ui-layer.ts:11](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/ui-layer.ts#L11)

## Methods

Expand All @@ -104,7 +104,7 @@ Changes the content of the UI layer.

#### Defined in

[src/advantage/ui-layer.ts:33](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/ui-layer.ts#L33)
[src/advantage/ui-layer.ts:33](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/ui-layer.ts#L33)

___

Expand All @@ -126,4 +126,4 @@ Inserts CSS styles into the UI layer.

#### Defined in

[src/advantage/ui-layer.ts:46](https://github.com/madington/advantage/blob/a3374afabf5379dfa1b20c1a8aa5f1925c135e7a/src/advantage/ui-layer.ts#L46)
[src/advantage/ui-layer.ts:46](https://github.com/get-advantage/advantage/blob/f2d41437895cf3f477be60f31147a43b479d51d7/src/advantage/ui-layer.ts#L46)
Loading

0 comments on commit c6dc118

Please sign in to comment.