Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

generate api documentation #1938

Merged
merged 3 commits into from
Sep 9, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions .prettierignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ lib
ios
android
docs/.docusaurus
docs/docs/api
1 change: 1 addition & 0 deletions docs/docs/api/.nojekyll
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false.
111 changes: 111 additions & 0 deletions docs/docs/api/classes/PurchaseError.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,111 @@
[react-native-iap](../README.md) / [Exports](../modules.md) / PurchaseError

# Class: PurchaseError

## Implements

- `Error`

## Table of contents

### Constructors

- [constructor](PurchaseError.md#constructor)

### Properties

- [code](PurchaseError.md#code)
- [debugMessage](PurchaseError.md#debugmessage)
- [message](PurchaseError.md#message)
- [name](PurchaseError.md#name)
- [productId](PurchaseError.md#productid)
- [responseCode](PurchaseError.md#responsecode)

## Constructors

### constructor

• **new PurchaseError**(`name`, `message`, `responseCode?`, `debugMessage?`, `code?`, `productId?`)

#### Parameters

| Name | Type |
| :------ | :------ |
| `name` | `string` |
| `message` | `string` |
| `responseCode?` | `number` |
| `debugMessage?` | `string` |
| `code?` | [`ErrorCode`](../enums/ErrorCode.md) |
| `productId?` | `string` |

#### Defined in

[purchaseError.ts:21](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L21)

## Properties

### code

• `Optional` **code**: [`ErrorCode`](../enums/ErrorCode.md)

#### Defined in

[purchaseError.ts:26](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L26)

___

### debugMessage

• `Optional` **debugMessage**: `string`

#### Defined in

[purchaseError.ts:25](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L25)

___

### message

• **message**: `string`

#### Implementation of

Error.message

#### Defined in

[purchaseError.ts:23](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L23)

___

### name

• **name**: `string`

#### Implementation of

Error.name

#### Defined in

[purchaseError.ts:22](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L22)

___

### productId

• `Optional` **productId**: `string`

#### Defined in

[purchaseError.ts:27](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L27)

___

### responseCode

• `Optional` **responseCode**: `number`

#### Defined in

[purchaseError.ts:24](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L24)
184 changes: 184 additions & 0 deletions docs/docs/api/enums/ErrorCode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,184 @@
[react-native-iap](../README.md) / [Exports](../modules.md) / ErrorCode

# Enumeration: ErrorCode

## Table of contents

### Enumeration Members

- [E\_ALREADY\_OWNED](ErrorCode.md#e_already_owned)
- [E\_BILLING\_RESPONSE\_JSON\_PARSE\_ERROR](ErrorCode.md#e_billing_response_json_parse_error)
- [E\_DEFERRED\_PAYMENT](ErrorCode.md#e_deferred_payment)
- [E\_DEVELOPER\_ERROR](ErrorCode.md#e_developer_error)
- [E\_INTERRUPTED](ErrorCode.md#e_interrupted)
- [E\_ITEM\_UNAVAILABLE](ErrorCode.md#e_item_unavailable)
- [E\_NETWORK\_ERROR](ErrorCode.md#e_network_error)
- [E\_NOT\_ENDED](ErrorCode.md#e_not_ended)
- [E\_NOT\_PREPARED](ErrorCode.md#e_not_prepared)
- [E\_RECEIPT\_FAILED](ErrorCode.md#e_receipt_failed)
- [E\_RECEIPT\_FINISHED\_FAILED](ErrorCode.md#e_receipt_finished_failed)
- [E\_REMOTE\_ERROR](ErrorCode.md#e_remote_error)
- [E\_SERVICE\_ERROR](ErrorCode.md#e_service_error)
- [E\_UNKNOWN](ErrorCode.md#e_unknown)
- [E\_USER\_CANCELLED](ErrorCode.md#e_user_cancelled)
- [E\_USER\_ERROR](ErrorCode.md#e_user_error)

## Enumeration Members

### E\_ALREADY\_OWNED

• **E\_ALREADY\_OWNED** = ``"E_ALREADY_OWNED"``

#### Defined in

[purchaseError.ts:13](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L13)

___

### E\_BILLING\_RESPONSE\_JSON\_PARSE\_ERROR

• **E\_BILLING\_RESPONSE\_JSON\_PARSE\_ERROR** = ``"E_BILLING_RESPONSE_JSON_PARSE_ERROR"``

#### Defined in

[purchaseError.ts:15](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L15)

___

### E\_DEFERRED\_PAYMENT

• **E\_DEFERRED\_PAYMENT** = ``"E_DEFERRED_PAYMENT"``

#### Defined in

[purchaseError.ts:16](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L16)

___

### E\_DEVELOPER\_ERROR

• **E\_DEVELOPER\_ERROR** = ``"E_DEVELOPER_ERROR"``

#### Defined in

[purchaseError.ts:14](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L14)

___

### E\_INTERRUPTED

• **E\_INTERRUPTED** = ``"E_INTERRUPTED"``

#### Defined in

[purchaseError.ts:17](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L17)

___

### E\_ITEM\_UNAVAILABLE

• **E\_ITEM\_UNAVAILABLE** = ``"E_ITEM_UNAVAILABLE"``

#### Defined in

[purchaseError.ts:5](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L5)

___

### E\_NETWORK\_ERROR

• **E\_NETWORK\_ERROR** = ``"E_NETWORK_ERROR"``

#### Defined in

[purchaseError.ts:7](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L7)

___

### E\_NOT\_ENDED

• **E\_NOT\_ENDED** = ``"E_NOT_ENDED"``

#### Defined in

[purchaseError.ts:12](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L12)

___

### E\_NOT\_PREPARED

• **E\_NOT\_PREPARED** = ``"E_NOT_PREPARED"``

#### Defined in

[purchaseError.ts:11](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L11)

___

### E\_RECEIPT\_FAILED

• **E\_RECEIPT\_FAILED** = ``"E_RECEIPT_FAILED"``

#### Defined in

[purchaseError.ts:9](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L9)

___

### E\_RECEIPT\_FINISHED\_FAILED

• **E\_RECEIPT\_FINISHED\_FAILED** = ``"E_RECEIPT_FINISHED_FAILED"``

#### Defined in

[purchaseError.ts:10](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L10)

___

### E\_REMOTE\_ERROR

• **E\_REMOTE\_ERROR** = ``"E_REMOTE_ERROR"``

#### Defined in

[purchaseError.ts:6](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L6)

___

### E\_SERVICE\_ERROR

• **E\_SERVICE\_ERROR** = ``"E_SERVICE_ERROR"``

#### Defined in

[purchaseError.ts:8](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L8)

___

### E\_UNKNOWN

• **E\_UNKNOWN** = ``"E_UNKNOWN"``

#### Defined in

[purchaseError.ts:2](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L2)

___

### E\_USER\_CANCELLED

• **E\_USER\_CANCELLED** = ``"E_USER_CANCELLED"``

#### Defined in

[purchaseError.ts:3](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L3)

___

### E\_USER\_ERROR

• **E\_USER\_ERROR** = ``"E_USER_ERROR"``

#### Defined in

[purchaseError.ts:4](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/purchaseError.ts#L4)
41 changes: 41 additions & 0 deletions docs/docs/api/enums/InstallSourceAndroid.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
[react-native-iap](../README.md) / [Exports](../modules.md) / InstallSourceAndroid

# Enumeration: InstallSourceAndroid

## Table of contents

### Enumeration Members

- [AMAZON](InstallSourceAndroid.md#amazon)
- [GOOGLE\_PLAY](InstallSourceAndroid.md#google_play)
- [NOT\_SET](InstallSourceAndroid.md#not_set)

## Enumeration Members

### AMAZON

• **AMAZON** = ``2``

#### Defined in

[types/index.ts:29](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/types/index.ts#L29)

___

### GOOGLE\_PLAY

• **GOOGLE\_PLAY** = ``1``

#### Defined in

[types/index.ts:28](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/types/index.ts#L28)

___

### NOT\_SET

• **NOT\_SET** = ``0``

#### Defined in

[types/index.ts:27](https://github.com/dooboolab/react-native-iap/blob/d06ab43/src/types/index.ts#L27)
Loading