Skip to content

Commit 0dc0a6d

Browse files
committed
Unify API docs
1 parent 9b0b182 commit 0dc0a6d

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

README.md

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -127,32 +127,32 @@ API
127127
bcrypt namespace.
128128

129129

130-
### bcrypt.genSaltSync(rounds\*, seed_length\*)
130+
### bcrypt.genSaltSync(rounds=, seed_length=)
131131
Synchronously generates a salt.
132132

133133
| Name | Type | Description |
134134
| ---- | ---- | ----------- |
135-
| rounds\* | number | Number of rounds to use, defaults to 10 if omitted |
136-
| seed_length\* | number | Not supported. |
135+
| rounds | number | Number of rounds to use, defaults to 10 if omitted |
136+
| seed_length | number | Not supported. |
137137
| |||
138138
| **returns** | string | Resulting salt
139139

140-
### bcrypt.genSalt(rounds\*, seed_length\*, callback\*)
140+
### bcrypt.genSalt(rounds=, seed_length=, callback)
141141
Asynchronously generates a salt.
142142

143143
| Name | Type | Description |
144144
| ---- | ---- | ----------- |
145-
| rounds\* | (number ¦ function(Error, ?string)) | Number of rounds to use, defaults to 10 if omitted |
146-
| seed_length\* | (number ¦ function(Error, ?string)) | Not supported. |
147-
| callback\* | function(Error, ?string) | Callback receiving the error, if any, and the resulting salt |
145+
| rounds | (number ¦ function(Error, ?string)) | Number of rounds to use, defaults to 10 if omitted |
146+
| seed_length | (number ¦ function(Error, ?string)) | Not supported. |
147+
| callback | function(Error, ?string) | Callback receiving the error, if any, and the resulting salt |
148148

149-
### bcrypt.hashSync(s, salt\*)
149+
### bcrypt.hashSync(s, salt=)
150150
Synchronously generates a hash for the given string.
151151

152152
| Name | Type | Description |
153153
| ---- | ---- | ----------- |
154154
| s | string | String to hash |
155-
| salt\* | (number ¦ string) | Salt length to generate or salt to use, default to 10 |
155+
| salt | (number ¦ string) | Salt length to generate or salt to use, default to 10 |
156156
| |||
157157
| **returns** | ?string | Resulting hash, actually never null
158158

0 commit comments

Comments
 (0)