Skip to content

Commit e3cd07e

Browse files
committed
docs: regenerate typedoc
1 parent 1acf899 commit e3cd07e

20 files changed

+812
-329
lines changed

docs/README.md

Lines changed: 408 additions & 0 deletions
Large diffs are not rendered by default.
Lines changed: 11 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
**[@invertase/react-native-apple-authentication](../README.md)**
12

23
# Enumeration: AndroidResponseType
34

@@ -7,28 +8,28 @@
78

89
* [ALL](_lib_index_d_.androidresponsetype.md#all)
910
* [CODE](_lib_index_d_.androidresponsetype.md#code)
10-
* [ID_TOKEN](_lib_index_d_.androidresponsetype.md#id_token)
11+
* [ID\_TOKEN](_lib_index_d_.androidresponsetype.md#id_token)
1112

1213
## Enumeration members
1314

14-
### ALL
15+
### ALL
1516

16-
**ALL**: = "ALL"
17+
**ALL**: = "ALL"
1718

18-
*Defined in [lib/index.d.ts:493](../../lib/index.d.ts#L493)*
19+
*Defined in [lib/index.d.ts:500](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L500)*
1920

2021
___
2122

22-
### CODE
23+
### CODE
2324

24-
**CODE**: = "CODE"
25+
**CODE**: = "CODE"
2526

26-
*Defined in [lib/index.d.ts:494](../../lib/index.d.ts#L494)*
27+
*Defined in [lib/index.d.ts:501](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L501)*
2728

2829
___
2930

30-
### ID_TOKEN
31+
### ID\_TOKEN
3132

32-
**ID_TOKEN**: = "ID_TOKEN"
33+
**ID\_TOKEN**: = "ID\_TOKEN"
3334

34-
*Defined in [lib/index.d.ts:495](../../lib/index.d.ts#L495)*
35+
*Defined in [lib/index.d.ts:502](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L502)*
Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
**[@invertase/react-native-apple-authentication](../README.md)**
12

23
# Enumeration: AndroidScope
34

@@ -11,24 +12,24 @@
1112

1213
## Enumeration members
1314

14-
### ALL
15+
### ALL
1516

16-
**ALL**: = "ALL"
17+
**ALL**: = "ALL"
1718

18-
*Defined in [lib/index.d.ts:499](../../lib/index.d.ts#L499)*
19+
*Defined in [lib/index.d.ts:506](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L506)*
1920

2021
___
2122

22-
### EMAIL
23+
### EMAIL
2324

24-
**EMAIL**: = "EMAIL"
25+
**EMAIL**: = "EMAIL"
2526

26-
*Defined in [lib/index.d.ts:500](../../lib/index.d.ts#L500)*
27+
*Defined in [lib/index.d.ts:507](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L507)*
2728

2829
___
2930

30-
### NAME
31+
### NAME
3132

32-
**NAME**: = "NAME"
33+
**NAME**: = "NAME"
3334

34-
*Defined in [lib/index.d.ts:501](../../lib/index.d.ts#L501)*
35+
*Defined in [lib/index.d.ts:508](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L508)*
Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
**[@invertase/react-native-apple-authentication](../README.md)**
12

23
# Enumeration: AppleButtonStyle
34

@@ -10,44 +11,44 @@ The Button style (mainly color) to render.
1011
* [BLACK](_lib_index_d_.applebuttonstyle.md#black)
1112
* [DEFAULT](_lib_index_d_.applebuttonstyle.md#default)
1213
* [WHITE](_lib_index_d_.applebuttonstyle.md#white)
13-
* [WHITE_OUTLINE](_lib_index_d_.applebuttonstyle.md#white_outline)
14+
* [WHITE\_OUTLINE](_lib_index_d_.applebuttonstyle.md#white_outline)
1415

1516
## Enumeration members
1617

17-
### BLACK
18+
### BLACK
1819

19-
**BLACK**: = "Black"
20+
**BLACK**: = "Black"
2021

21-
*Defined in [lib/index.d.ts:73](../../lib/index.d.ts#L73)*
22+
*Defined in [lib/index.d.ts:73](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L73)*
2223

2324
Render a black button with white text.
2425

2526
___
2627

27-
### DEFAULT
28+
### DEFAULT
2829

29-
**DEFAULT**: = "White"
30+
**DEFAULT**: = "White"
3031

31-
*Defined in [lib/index.d.ts:58](../../lib/index.d.ts#L58)*
32+
*Defined in [lib/index.d.ts:58](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L58)*
3233

3334
The default style, White.
3435

3536
___
3637

37-
### WHITE
38+
### WHITE
3839

39-
**WHITE**: = "White"
40+
**WHITE**: = "White"
4041

41-
*Defined in [lib/index.d.ts:63](../../lib/index.d.ts#L63)*
42+
*Defined in [lib/index.d.ts:63](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L63)*
4243

4344
Render a white button with black text.
4445

4546
___
4647

47-
### WHITE_OUTLINE
48+
### WHITE\_OUTLINE
4849

49-
**WHITE_OUTLINE**: = "WhiteOutline"
50+
**WHITE\_OUTLINE**: = "WhiteOutline"
5051

51-
*Defined in [lib/index.d.ts:68](../../lib/index.d.ts#L68)*
52+
*Defined in [lib/index.d.ts:68](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L68)*
5253

5354
Render a white button with black text and a bordered outline.

docs/enums/_lib_index_d_.applebuttontype.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
**[@invertase/react-native-apple-authentication](../README.md)**
12

23
# Enumeration: AppleButtonType
34

@@ -9,46 +10,46 @@ The Apple Button type to render, this controls the button text.
910

1011
* [CONTINUE](_lib_index_d_.applebuttontype.md#continue)
1112
* [DEFAULT](_lib_index_d_.applebuttontype.md#default)
12-
* [SIGN_IN](_lib_index_d_.applebuttontype.md#sign_in)
13-
* [SIGN_UP](_lib_index_d_.applebuttontype.md#sign_up)
13+
* [SIGN\_IN](_lib_index_d_.applebuttontype.md#sign_in)
14+
* [SIGN\_UP](_lib_index_d_.applebuttontype.md#sign_up)
1415

1516
## Enumeration members
1617

17-
### CONTINUE
18+
### CONTINUE
1819

19-
**CONTINUE**: = "Continue"
20+
**CONTINUE**: = "Continue"
2021

21-
*Defined in [lib/index.d.ts:41](../../lib/index.d.ts#L41)*
22+
*Defined in [lib/index.d.ts:41](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L41)*
2223

2324
Renders the button with 'Continue with Apple'.
2425

2526
___
2627

27-
### DEFAULT
28+
### DEFAULT
2829

29-
**DEFAULT**: = "SignIn"
30+
**DEFAULT**: = "SignIn"
3031

31-
*Defined in [lib/index.d.ts:31](../../lib/index.d.ts#L31)*
32+
*Defined in [lib/index.d.ts:31](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L31)*
3233

3334
The default button, the same as `SIGN_IN`.
3435

3536
___
3637

37-
### SIGN_IN
38+
### SIGN\_IN
3839

39-
**SIGN_IN**: = "SignIn"
40+
**SIGN\_IN**: = "SignIn"
4041

41-
*Defined in [lib/index.d.ts:36](../../lib/index.d.ts#L36)*
42+
*Defined in [lib/index.d.ts:36](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L36)*
4243

4344
Renders the button with 'Sign in with Apple'.
4445

4546
___
4647

47-
### SIGN_UP
48+
### SIGN\_UP
4849

49-
**SIGN_UP**: = "SignUp"
50+
**SIGN\_UP**: = "SignUp"
5051

51-
*Defined in [lib/index.d.ts:48](../../lib/index.d.ts#L48)*
52+
*Defined in [lib/index.d.ts:48](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L48)*
5253

5354
Renders the button with 'Sign up with Apple'.
5455

docs/enums/_lib_index_d_.applecredentialstate.md

Lines changed: 14 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
**[@invertase/react-native-apple-authentication](../README.md)**
12

23
# Enumeration: AppleCredentialState
34

@@ -6,47 +7,47 @@
67
### Enumeration members
78

89
* [AUTHORIZED](_lib_index_d_.applecredentialstate.md#authorized)
9-
* [NOT_FOUND](_lib_index_d_.applecredentialstate.md#not_found)
10+
* [NOT\_FOUND](_lib_index_d_.applecredentialstate.md#not_found)
1011
* [REVOKED](_lib_index_d_.applecredentialstate.md#revoked)
1112
* [TRANSFERRED](_lib_index_d_.applecredentialstate.md#transferred)
1213

1314
## Enumeration members
1415

15-
### AUTHORIZED
16+
### AUTHORIZED
1617

17-
**AUTHORIZED**: = 1
18+
**AUTHORIZED**: = 1
1819

19-
*Defined in [lib/index.d.ts:211](../../lib/index.d.ts#L211)*
20+
*Defined in [lib/index.d.ts:216](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L216)*
2021

2122
The Opaque user ID is in good state.
2223

2324
___
2425

25-
### NOT_FOUND
26+
### NOT\_FOUND
2627

27-
**NOT_FOUND**: = 2
28+
**NOT\_FOUND**: = 2
2829

29-
*Defined in [lib/index.d.ts:216](../../lib/index.d.ts#L216)*
30+
*Defined in [lib/index.d.ts:221](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L221)*
3031

3132
The Opaque user ID was not found.
3233

3334
___
3435

35-
### REVOKED
36+
### REVOKED
3637

37-
**REVOKED**: = 0
38+
**REVOKED**: = 0
3839

39-
*Defined in [lib/index.d.ts:206](../../lib/index.d.ts#L206)*
40+
*Defined in [lib/index.d.ts:211](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L211)*
4041

4142
The Opaque user ID was revoked by the user.
4243

4344
___
4445

45-
### TRANSFERRED
46+
### TRANSFERRED
4647

47-
**TRANSFERRED**: = 3
48+
**TRANSFERRED**: = 3
4849

49-
*Defined in [lib/index.d.ts:223](../../lib/index.d.ts#L223)*
50+
*Defined in [lib/index.d.ts:228](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L228)*
5051

5152
N/A
5253

Lines changed: 18 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
**[@invertase/react-native-apple-authentication](../README.md)**
12

23
# Enumeration: AppleError
34

@@ -9,56 +10,56 @@ iOS
910

1011
* [CANCELED](_lib_index_d_.appleerror.md#canceled)
1112
* [FAILED](_lib_index_d_.appleerror.md#failed)
12-
* [INVALID_RESPONSE](_lib_index_d_.appleerror.md#invalid_response)
13-
* [NOT_HANDLED](_lib_index_d_.appleerror.md#not_handled)
13+
* [INVALID\_RESPONSE](_lib_index_d_.appleerror.md#invalid_response)
14+
* [NOT\_HANDLED](_lib_index_d_.appleerror.md#not_handled)
1415
* [UNKNOWN](_lib_index_d_.appleerror.md#unknown)
1516

1617
## Enumeration members
1718

18-
### CANCELED
19+
### CANCELED
1920

20-
**CANCELED**: = "1001"
21+
**CANCELED**: = "1001"
2122

22-
*Defined in [lib/index.d.ts:130](../../lib/index.d.ts#L130)*
23+
*Defined in [lib/index.d.ts:135](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L135)*
2324

2425
The user canceled the authorization attempt.
2526

2627
___
2728

28-
### FAILED
29+
### FAILED
2930

30-
**FAILED**: = "1004"
31+
**FAILED**: = "1004"
3132

32-
*Defined in [lib/index.d.ts:145](../../lib/index.d.ts#L145)*
33+
*Defined in [lib/index.d.ts:150](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L150)*
3334

3435
The authorization attempt failed.
3536

3637
___
3738

38-
### INVALID_RESPONSE
39+
### INVALID\_RESPONSE
3940

40-
**INVALID_RESPONSE**: = "1002"
41+
**INVALID\_RESPONSE**: = "1002"
4142

42-
*Defined in [lib/index.d.ts:135](../../lib/index.d.ts#L135)*
43+
*Defined in [lib/index.d.ts:140](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L140)*
4344

4445
The authorization request received an invalid response.
4546

4647
___
4748

48-
### NOT_HANDLED
49+
### NOT\_HANDLED
4950

50-
**NOT_HANDLED**: = "1003"
51+
**NOT\_HANDLED**: = "1003"
5152

52-
*Defined in [lib/index.d.ts:140](../../lib/index.d.ts#L140)*
53+
*Defined in [lib/index.d.ts:145](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L145)*
5354

5455
The authorization request wasn't handled.
5556

5657
___
5758

58-
### UNKNOWN
59+
### UNKNOWN
5960

60-
**UNKNOWN**: = "1000"
61+
**UNKNOWN**: = "1000"
6162

62-
*Defined in [lib/index.d.ts:125](../../lib/index.d.ts#L125)*
63+
*Defined in [lib/index.d.ts:130](https://github.com/invertase/react-native-apple-authentication/blob/91271b4/lib/index.d.ts#L130)*
6364

6465
The authorization attempt failed for an unknown reason.

0 commit comments

Comments
 (0)