Skip to content

Commit 190b45a

Browse files
eugenehpeugenehp
committed
fix: documentation
1 parent d476a1f commit 190b45a

File tree

22 files changed

+1265
-12
lines changed

22 files changed

+1265
-12
lines changed

‎README.md‎

Lines changed: 17 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,31 +26,44 @@ Huge thanks to [Randy Coulman](https://github.com/randycoulman) for the early ve
2626

2727
## Getting started
2828

29-
Use this steps to install and create UUIDs.
29+
Use this steps to install and create UUIDs. Example projec is available [here](https://github.com/eugenehp/RNUUID)
3030

3131
### 1. Install
3232

3333
```shell
3434
npm install react-native-uuid
3535
```
3636

37-
### 2. Create a UUID (ES6 module syntax)
37+
### 2. Create a UUID
3838

3939
```javascript
40-
import * as uuid from 'react-native-uuid';
40+
import uuid from 'react-native-uuid';
4141
uuid.v4(); // ⇨ '11edc52b-2918-4d71-9058-f7285e29d894'
4242
```
4343

44+
## Documentation
45+
46+
Methods documentation is available [here](./docs/modules.md)
47+
4448
## Troubleshooting
4549

4650
Previous version has been based on `randombytes` that is not compatible with react-native out of the box.
4751
Please submit an [issue](https://github.com/eugenehp/react-native-uuid/issues) if you found a bug.
4852

49-
5053
## react-native-uuid for enterprise
5154

5255
Available as part of the Tidelift Subscription.
5356

5457
The maintainers of react-native-uuid and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source packages you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact packages you use. [Learn more.](https://tidelift.com/subscription/pkg/npm-react-native-uuid?utm_source=npm-react-native-uuid&utm_medium=referral&utm_campaign=enterprise&utm_term=repo)
5558

59+
## Sponsorship
60+
61+
Thank you to our sponsors:
62+
63+
[<img width="300px" src="https://user-images.githubusercontent.com/1857263/114124204-c4e1eb80-98a8-11eb-80ab-64683c24bbc5.png" alt="Reactive Lions™" target="_blank">](https://www.reactivelions.com)
64+
65+
## License
66+
67+
[MIT](./LICENSE)
68+
5669
Copyright (c) 2016-2021 Eugene Hauptmann

‎docs/modules.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
[react-native-uuid](.) / Exports
2+
3+
# react-native-uuid
4+
5+
## Table of contents
6+
7+
### Modules
8+
9+
- [index](modules/index.md)
10+
- [md5](modules/md5.md)
11+
- [parse](modules/parse.md)
12+
- [regex](modules/regex.md)
13+
- [rng](modules/rng.md)
14+
- [sha1](modules/sha1.md)
15+
- [stringify](modules/stringify.md)
16+
- [unparse](modules/unparse.md)
17+
- [utils](modules/utils.md)
18+
- [v1](modules/v1.md)
19+
- [v3](modules/v3.md)
20+
- [v35](modules/v35.md)
21+
- [v4](modules/v4.md)
22+
- [v5](modules/v5.md)
23+
- [validate](modules/validate.md)
24+
- [version](modules/version.md)

‎docs/modules/index.md‎

Lines changed: 43 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
[react-native-uuid](..) / [Exports](../modules.md) / index
2+
3+
# Module: index
4+
5+
## Table of contents
6+
7+
### References
8+
9+
- [GenerateUUID](index.md#generateuuid)
10+
11+
### Properties
12+
13+
- [default](index.md#default)
14+
15+
## References
16+
17+
### GenerateUUID
18+
19+
Re-exports: [GenerateUUID](v35.md#generateuuid)
20+
21+
## Properties
22+
23+
### default
24+
25+
• **default**: *object*
26+
27+
#### Type declaration:
28+
29+
Name | Type |
30+
:------ | :------ |
31+
`DNS` | *string* |
32+
`NIL` | *string* |
33+
`OID` | *string* |
34+
`URL` | *string* |
35+
`X500` | *string* |
36+
`parse` | (`s`: *string*, `buf?`: *number*[], `offset?`: *number*) => *number*[] |
37+
`unparse` | (`buf`: *number*[], `offset?`: *number*) => *string* |
38+
`v1` | (`options?`: V1Options, `buf?`: *Uint8Array*, `offset`: *number*) => *string* \| *Uint8Array* |
39+
`v3` | [*GenerateUUID*](v35.md#generateuuid) |
40+
`v4` | (`options?`: *string* \| V4Options, `buf?`: *number*[], `offset?`: *number*) => *string* \| *number*[] |
41+
`v5` | [*GenerateUUID*](v35.md#generateuuid) |
42+
`validate` | (`uuid`: *string*) => *boolean* |
43+
`version` | (`uuid`: *string*) => *number* |

‎docs/modules/md5.md‎

Lines changed: 125 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,125 @@
1+
[react-native-uuid](..) / [Exports](../modules.md) / md5
2+
3+
# Module: md5
4+
5+
## Table of contents
6+
7+
### References
8+
9+
- [default](md5.md#default)
10+
11+
### Functions
12+
13+
- [any\_hmac\_md5](md5.md#any_hmac_md5)
14+
- [any\_md5](md5.md#any_md5)
15+
- [b64\_hmac\_md5](md5.md#b64_hmac_md5)
16+
- [b64\_md5](md5.md#b64_md5)
17+
- [hex\_hmac\_md5](md5.md#hex_hmac_md5)
18+
- [hex\_md5](md5.md#hex_md5)
19+
20+
## References
21+
22+
### default
23+
24+
Renames and exports: [hex\_md5](md5.md#hex_md5)
25+
26+
## Functions
27+
28+
### any\_hmac\_md5
29+
30+
▸ `Const`**any_hmac_md5**(`k`: *string*, `d`: *string*, `e`: *string*): *string*
31+
32+
#### Parameters:
33+
34+
Name | Type |
35+
:------ | :------ |
36+
`k` | *string* |
37+
`d` | *string* |
38+
`e` | *string* |
39+
40+
**Returns:** *string*
41+
42+
Defined in: [md5.ts:39](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/md5.ts#L39)
43+
44+
___
45+
46+
### any\_md5
47+
48+
▸ `Const`**any_md5**(`s`: *string*, `e`: *string*): *string*
49+
50+
#### Parameters:
51+
52+
Name | Type |
53+
:------ | :------ |
54+
`s` | *string* |
55+
`e` | *string* |
56+
57+
**Returns:** *string*
58+
59+
Defined in: [md5.ts:30](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/md5.ts#L30)
60+
61+
___
62+
63+
### b64\_hmac\_md5
64+
65+
▸ `Const`**b64_hmac_md5**(`k`: *string*, `d`: *string*): *string*
66+
67+
#### Parameters:
68+
69+
Name | Type |
70+
:------ | :------ |
71+
`k` | *string* |
72+
`d` | *string* |
73+
74+
**Returns:** *string*
75+
76+
Defined in: [md5.ts:36](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/md5.ts#L36)
77+
78+
___
79+
80+
### b64\_md5
81+
82+
▸ `Const`**b64_md5**(`s`: *string*): *string*
83+
84+
#### Parameters:
85+
86+
Name | Type |
87+
:------ | :------ |
88+
`s` | *string* |
89+
90+
**Returns:** *string*
91+
92+
Defined in: [md5.ts:28](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/md5.ts#L28)
93+
94+
___
95+
96+
### hex\_hmac\_md5
97+
98+
▸ `Const`**hex_hmac_md5**(`k`: *string*, `d`: *string*): *string*
99+
100+
#### Parameters:
101+
102+
Name | Type |
103+
:------ | :------ |
104+
`k` | *string* |
105+
`d` | *string* |
106+
107+
**Returns:** *string*
108+
109+
Defined in: [md5.ts:33](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/md5.ts#L33)
110+
111+
___
112+
113+
### hex\_md5
114+
115+
▸ `Const`**hex_md5**(`s`: *string*): *string*
116+
117+
#### Parameters:
118+
119+
Name | Type |
120+
:------ | :------ |
121+
`s` | *string* |
122+
123+
**Returns:** *string*
124+
125+
Defined in: [md5.ts:25](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/md5.ts#L25)

‎docs/modules/parse.md‎

Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
[react-native-uuid](..) / [Exports](../modules.md) / parse
2+
3+
# Module: parse
4+
5+
## Table of contents
6+
7+
### Functions
8+
9+
- [parse](parse.md#parse)
10+
11+
## Functions
12+
13+
### parse
14+
15+
▸ `Const`**parse**(`s`: *string*, `buf?`: *number*[], `offset?`: *number*): *number*[]
16+
17+
#### Parameters:
18+
19+
Name | Type |
20+
:------ | :------ |
21+
`s` | *string* |
22+
`buf?` | *number*[] |
23+
`offset?` | *number* |
24+
25+
**Returns:** *number*[]
26+
27+
Defined in: [parse.ts:4](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/parse.ts#L4)

‎docs/modules/regex.md‎

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
[react-native-uuid](..) / [Exports](../modules.md) / regex
2+
3+
# Module: regex
4+
5+
## Table of contents
6+
7+
### Variables
8+
9+
- [default](regex.md#default)
10+
11+
## Variables
12+
13+
### default
14+
15+
• `Const` **default**: *RegExp*
16+
17+
Defined in: [regex.ts:1](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/regex.ts#L1)

‎docs/modules/rng.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
[react-native-uuid](..) / [Exports](../modules.md) / rng
2+
3+
# Module: rng
4+
5+
## Table of contents
6+
7+
### Functions
8+
9+
- [rng](rng.md#rng)
10+
11+
## Functions
12+
13+
### rng
14+
15+
▸ `Const`**rng**(): *number*[]
16+
17+
**Returns:** *number*[]
18+
19+
Defined in: [rng.ts:10](https://github.com/eugenehp/react-native-uuid/blob/d476a1f/src/rng.ts#L10)

0 commit comments

Comments
 (0)