Skip to content

Commit

Permalink
fix(*): remove types for hooks
Browse files Browse the repository at this point in the history
  • Loading branch information
@cley44
cley44 committed Jul 21, 2023
1 parent 7a2b34d commit c7f4b82
Show file tree
Hide file tree
Showing 4 changed files with 82 additions and 870 deletions.
68 changes: 34 additions & 34 deletions packages/screeb-sdk-angular/docs/classes/Screeb.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,8 @@

#### Parameters

| Name | Type |
| :------- | :-------------------------------- |
| Name | Type |
| :------ | :------ |
| `config` | [`ScreebConfig`](ScreebConfig.md) |

## Properties
Expand Down Expand Up @@ -117,10 +117,10 @@ ___

#### Parameters

| Name | Type | Default value |
| :------------- | :-------- | :------------ |
| `functionName` | `string` | `undefined` |
| `onlyLoaded` | `boolean` | `false` |
| Name | Type | Default value |
| :------ | :------ | :------ |
| `functionName` | `string` | `undefined` |
| `onlyLoaded` | `boolean` | `false` |

#### Returns

Expand Down Expand Up @@ -155,9 +155,9 @@ this.screeb.eventTrack(

#### Parameters

| Name | Type | Description |
| :----------------- | :--------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `eventName` | `string` | The event name. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `eventName` | `string` | The event name. |
| `eventProperties?` | `PropertyRecord` | The properties of your event. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |

#### Returns
Expand Down Expand Up @@ -190,9 +190,9 @@ this.screeb.identity(

#### Parameters

| Name | Type | Description |
| :---------------- | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `userId` | `string` | The unique identifier of your user. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `userId` | `string` | The unique identifier of your user. |
| `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |

#### Returns
Expand All @@ -212,13 +212,13 @@ Retrieves the current user identity.
```ts
console.log(await this.screeb.identityGet());
// {
// channel_id: "<UUID>",
// anonymous_id: "<UUID>",
// user_id: "<UUID>",
// is_ready: true,
// session_id: "<UUID>",
// session_start: "2023-05-04T16:30:15.882Z",
// session_end: "2023-05-04T17:02:09.087Z",
// channel_id: "<UUID>",
// is_ready: true,
// }
```

Expand Down Expand Up @@ -253,10 +253,10 @@ this.screeb.identityGroupAssign(

#### Parameters

| Name | Type | Description |
| :----------------- | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `groupName` | `string` | |
| `groupType?` | `string` | |
| Name | Type | Description |
| :------ | :------ | :------ |
| `groupName` | `string` | |
| `groupType?` | `string` | |
| `groupProperties?` | `PropertyRecord` | The properties of your user group. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |

#### Returns
Expand All @@ -279,9 +279,9 @@ this.screeb.identityGroupUnassign('company', 'Apple');

#### Parameters

| Name | Type | Description |
| :----------- | :------- | :--------------------------- |
| `groupName` | `string` | The name of your user group. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `groupName` | `string` | The name of your user group. |
| `groupType?` | `string` | The type of your user group. |

#### Returns
Expand Down Expand Up @@ -322,8 +322,8 @@ this.screeb.identityProperties(

#### Parameters

| Name | Type | Description |
| :--------------- | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| Name | Type | Description |
| :------ | :------ | :------ |
| `userProperties` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date. ``` |

#### Returns
Expand Down Expand Up @@ -380,12 +380,12 @@ this.screeb.init(

#### Parameters

| Name | Type | Description |
| :---------------- | :--------------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
| `websiteId` | `string` | Your website/channel id. |
| `userId?` | `string` | The unique identifier of your user. |
| Name | Type | Description |
| :------ | :------ | :------ |
| `websiteId` | `string` | Your website/channel id. |
| `userId?` | `string` | The unique identifier of your user. |
| `userProperties?` | `PropertyRecord` | The properties of your user. ```text Requirements: - Property names must be limited to 128 characters - No more than 1000 attributes - Supported types for values: string, number, boolean and Date ``` |
| `hooks?` | `GlobalHooks` | - |
| `hooks?` | `GlobalHooks` | - |

#### Returns

Expand Down Expand Up @@ -455,12 +455,12 @@ this.screeb.surveyStart(

#### Parameters

| Name | Type |
| :----------------------- | :--------------- |
| `surveyId` | `string` |
| `allowMultipleResponses` | `boolean` |
| `hiddenFields` | `PropertyRecord` |
| `hooks?` | `SurveyHooks` |
| Name | Type |
| :------ | :------ |
| `surveyId` | `string` |
| `allowMultipleResponses` | `boolean` |
| `hiddenFields` | `PropertyRecord` |
| `hooks?` | `SurveyHooks` |

#### Returns

Expand Down
10 changes: 5 additions & 5 deletions packages/screeb-sdk-angular/docs/classes/ScreebModule.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,10 +20,10 @@

#### Parameters

| Name | Type |
| :------- | :-------------------------------- |
| Name | Type |
| :------ | :------ |
| `config` | [`ScreebConfig`](ScreebConfig.md) |
| `screeb` | [`Screeb`](Screeb.md) |
| `screeb` | [`Screeb`](Screeb.md) |

## Methods

Expand Down Expand Up @@ -57,8 +57,8 @@ ScreebModule.forRoot({

#### Parameters

| Name | Type | Description |
| :------- | :-------------------------------- | :------------------------------------------ |
| Name | Type | Description |
| :------ | :------ | :------ |
| `config` | [`ScreebConfig`](ScreebConfig.md) | Configuration to pass to Screeb browser SDK |

#### Returns
Expand Down
Loading

0 comments on commit c7f4b82

Please sign in to comment.