2019-04-16 06:55:37 +00:00
|
|
|
# @pushrocks/smartstring
|
2016-05-25 07:02:24 +00:00
|
|
|
handle strings in smart ways. TypeScript ready.
|
2016-05-16 22:02:29 +00:00
|
|
|
|
2019-04-16 06:55:37 +00:00
|
|
|
## Availabililty and Links
|
|
|
|
|
* [npmjs.org (npm package)](https://www.npmjs.com/package/@pushrocks/smartstring)
|
|
|
|
|
* [gitlab.com (source)](https://gitlab.com/pushrocks/smartstring)
|
|
|
|
|
* [github.com (source mirror)](https://github.com/pushrocks/smartstring)
|
|
|
|
|
* [docs (typedoc)](https://pushrocks.gitlab.io/smartstring/)
|
2016-10-31 23:22:38 +00:00
|
|
|
|
|
|
|
|
## Status for master
|
2019-04-16 06:55:37 +00:00
|
|
|
[](https://gitlab.com/pushrocks/smartstring/commits/master)
|
|
|
|
|
[](https://gitlab.com/pushrocks/smartstring/commits/master)
|
|
|
|
|
[](https://www.npmjs.com/package/@pushrocks/smartstring)
|
|
|
|
|
[](https://snyk.io/test/npm/@pushrocks/smartstring)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
|
[](https://nodejs.org/dist/latest-v10.x/docs/api/)
|
|
|
|
|
[](https://prettier.io/)
|
2016-05-16 22:02:29 +00:00
|
|
|
|
|
|
|
|
## Usage
|
2018-07-21 12:37:39 +00:00
|
|
|
|
2017-02-19 13:33:00 +00:00
|
|
|
Use TypeScript for best in class instellisense.
|
2016-05-25 07:02:24 +00:00
|
|
|
|
2016-11-02 22:01:56 +00:00
|
|
|
```javascript
|
2018-07-21 12:37:39 +00:00
|
|
|
import * as smartstring from 'smartstring';
|
2016-05-25 07:02:24 +00:00
|
|
|
|
2016-11-02 21:55:17 +00:00
|
|
|
// classes
|
|
|
|
|
|
|
|
|
|
// smartstring.Domain class
|
2018-07-21 12:37:39 +00:00
|
|
|
let myDomain = new smartstring.Domain('https://sub.main.tld');
|
|
|
|
|
myDomain.level1; // "tld"
|
|
|
|
|
myDomain.level2; // "main"
|
2016-11-02 21:55:17 +00:00
|
|
|
// level3 , level 4 and so on...
|
2018-07-21 12:37:39 +00:00
|
|
|
myDomain.zoneName; // "main.tld"
|
|
|
|
|
myDOmain.protocol; // "https"
|
2016-11-02 21:55:17 +00:00
|
|
|
|
2016-05-25 07:02:24 +00:00
|
|
|
// smartstring.GitRepo class
|
2018-07-21 12:37:39 +00:00
|
|
|
let myGitRepo = new smartstring.GitRepo('git@github.com:someorg/somerepo.git'); // takes https and git and npm repo URL versions
|
|
|
|
|
myGitRepo.host; // "github.com"
|
|
|
|
|
myGitRepo.user; // "someorg"
|
|
|
|
|
myGitRepo.repo; // "somerepo"
|
|
|
|
|
myGitRepo.accessToken; // accessToken if specified with https
|
|
|
|
|
myGitRepo.sshUrl; // "git@github.com:someorg/somerepo.git" (computed also from https)
|
|
|
|
|
myGitRepo.httpsUrl; // "https://github.com/someorg/somerepo.git" (computed also from ssh)
|
2016-05-25 07:02:24 +00:00
|
|
|
|
2016-11-02 21:55:17 +00:00
|
|
|
//smartstring.Base64
|
2018-07-21 12:37:39 +00:00
|
|
|
let myBase64 = new smartstring.Base64('somestring', 'string'); // first arg is the string, second is string type (can be string, base64, base64uri)
|
|
|
|
|
myBase64.simpleString; // 'somestring'
|
|
|
|
|
myBase64.base64String; // base64 representation of 'somestring'
|
|
|
|
|
myBase64.base64UriString; // base64uri representation of 'sometring'
|
2016-11-02 21:55:17 +00:00
|
|
|
|
|
|
|
|
// methods
|
2018-07-21 12:37:39 +00:00
|
|
|
smartstring.base64.encode('somestring'); // encodes 'somestring' to base64
|
|
|
|
|
smartstring.base64.encodeUri('sometring'); // encodes 'somestring' to base64uri
|
|
|
|
|
smartstring.base64.decode(); // decodes base64 and base64uri to simple string respresentation
|
2016-11-02 21:55:17 +00:00
|
|
|
|
2018-07-21 12:37:39 +00:00
|
|
|
smartstring.indent.indent('somestringanotherstring', 4); // indents a string by 4
|
|
|
|
|
smartstring.indent.indent('somestringanotherstring', '>>>> '); // indents a string with a prefix
|
|
|
|
|
smartstring.indent.normalize(' somestring anotherstring', '>>>> '); // looks for the least amount of indention and removes superflouous space
|
2016-05-25 07:02:24 +00:00
|
|
|
```
|
2016-05-25 07:05:04 +00:00
|
|
|
|
2019-04-16 06:55:37 +00:00
|
|
|
For further information read the linked docs at the top of this readme.
|
2017-02-19 13:33:00 +00:00
|
|
|
|
|
|
|
|
> MIT licensed | **©** [Lossless GmbH](https://lossless.gmbh)
|
2019-04-16 06:55:37 +00:00
|
|
|
| By using this npm module you agree to our [privacy policy](https://lossless.gmbH/privacy.html)
|
2017-02-19 13:33:00 +00:00
|
|
|
|
2019-04-16 06:55:37 +00:00
|
|
|
[](https://maintainedby.lossless.com)
|
