# RandomString After created an instance of `RandomString` you can have access to all methods. ```javascript import { RandomString } from '@akanass/rx-crypto'; const randomString: RandomString = new RandomString(); ``` ## Table of contents * [API in Detail](#api-in-detail) * [.generate([options])](#generateoptions) * [Parameters types in detail](#parameters-types-in-detail) * [GenerateOptions](#generateoptions) * [Change History](#change-history) ## API in Detail ### `.generate([options])` Creates `random` string for given `options` **Parameters:** > - ***{GenerateOptions | number} options*** *(optional): `object` or `number` to configure data of generation.* **Response:** > *{[RxJS.Observable](https://github.com/ReactiveX/rxjs/blob/master/src/internal/Observable.ts)} The successfully generated `string`.* **Example:** ```javascript randomString.generate() .subscribe( (s: string) => console.log(s), // Show `XwPp9xazJ0ku5CZnlmgAx2Dld8SHkAeT` in the console e => console.error(e.message) // Show error message in the console ); randomString.generate(7) .subscribe( (s: string) => console.log(s), // Show `xqm5wXX` in the console e => console.error(e.message) // Show error message in the console ); randomString.generate( { length: 12, charset: 'alphabetic' } ).subscribe( (s: string) => console.log(s), // Show `AqoTIzKurxJi` in the console e => console.error(e.message) // Show error message in the console ); randomString.generate( { charset: 'abc' } ).subscribe( (s: string) => console.log(s), // Show `accbaabbbbcccbccccaacacbbcbbcbbc` in the console e => console.error(e.message) // Show error message in the console ); ``` [Back to top](#table-of-contents) ## Parameters types in detail ### *GenerateOptions:* > - ***{number} length*** *(optional): the length of the random string. (default: `32`)* > - ***{boolean} readable*** *(optional): exclude poorly readable chars: 0OIl. (default: `false`)* > - ***{string} charset*** *(optional): define the character set for the string. (default: `alphanumeric`) (`alphanumeric` - [0-9 a-z A-Z], `alphabetic` - [a-z A-Z], `numeric` - [0-9], `hex` - [0-9 a-f], `custom` - any given characters)* > - ***{string} capitalization*** *(optional): define whether the output should be lowercase / uppercase only. (default: `null`) (`lowercase`, `uppercase`)* [Back to top](#table-of-contents) ## Change History * Implementation of all methods (2019-08-27) * [.generate([options])](#generateoptions) [Back to top](#table-of-contents)