@@ -98,14 +98,16 @@ export class StringModule {
98
98
/**
99
99
* Generating a string consisting of letters in the English alphabet.
100
100
*
101
- * @param options Either the number of characters or an options instance. Defaults to `{ length: 1, casing: 'lower ', bannedChars: [] }`.
101
+ * @param options Either the number of characters or an options instance. Defaults to `{ length: 1, casing: 'mixed ', bannedChars: [] }`.
102
102
* @param options.length The number of characters to generate. Defaults to `1`.
103
- * @param options.casing The casing of the characters. Defaults to `'lower '`.
103
+ * @param options.casing The casing of the characters. Defaults to `'mixed '`.
104
104
* @param options.bannedChars An array with characters to exclude. Defaults to `[]`.
105
105
*
106
106
* @example
107
107
* faker.string.alpha() // 'b'
108
- * faker.string.alpha(10) // 'qccrabobaf'
108
+ * faker.string.alpha(10) // 'fEcAaCVbaR'
109
+ * faker.string.alpha({ casing: 'lower' }) // 'r'
110
+ * faker.string.alpha({ bannedChars: ['W'] }) // 'Z'
109
111
* faker.string.alpha({ length: 5, casing: 'upper', bannedChars: ['A'] }) // 'DTCIC'
110
112
*
111
113
* @since 8.0.0
@@ -173,8 +175,10 @@ export class StringModule {
173
175
*
174
176
* @example
175
177
* faker.string.alphanumeric() // '2'
176
- * faker.string.alphanumeric(5) // '3e5v7'
177
- * faker.string.alphanumeric({ length: 5, bannedChars: ["a"] }) // 'xszlm'
178
+ * faker.string.alphanumeric(5) // '3e5V7'
179
+ * faker.string.alphanumeric({ casing: 'upper' }) // 'A'
180
+ * faker.string.alphanumeric({ bannedChars: ['W'] }) // 'r'
181
+ * faker.string.alphanumeric({ length: 5, bannedChars: ["a"] }) // 'x1Z7f'
178
182
*
179
183
* @since 8.0.0
180
184
*/
0 commit comments