A library for handling strings in smart ways, including manipulation and encoding, with TypeScript support.
Go to file
2017-10-26 15:24:13 +02:00
dist refactor to const 2017-10-26 15:24:10 +02:00
test update normalize of smartstring 2017-10-05 15:55:59 +02:00
ts refactor to const 2017-10-26 15:24:10 +02:00
.gitignore refactor to const 2017-10-26 15:24:10 +02:00
.gitlab-ci.yml update normalize of smartstring 2017-10-05 15:55:59 +02:00
LICENSE Initial commit 2016-02-23 02:57:12 +01:00
npmextra.json refactor to const 2017-10-26 15:24:10 +02:00
package.json 2.0.28 2017-10-26 15:24:13 +02:00
README.md update README 2017-02-19 14:33:00 +01:00
tslint.json add Base64 handling 2016-11-01 00:22:38 +01:00
yarn.lock add create module 2017-10-11 14:52:22 +02:00

smartstring

handle strings in smart ways. TypeScript ready.

Availabililty

npm git git docs

Status for master

build status coverage report npm downloads per month Dependency Status bitHound Dependencies bitHound Code TypeScript node JavaScript Style Guide

Usage

Use TypeScript for best in class instellisense.

import * as smartstring from "smartstring";

// classes

// smartstring.Domain class
let myDomain = new smartstring.Domain("https://sub.main.tld");
myDomain.level1 // "tld"
myDomain.level2 // "main"
// level3 , level 4 and so on...
myDomain.zoneName // "main.tld"
myDOmain.protocol // "https"

// smartstring.GitRepo class
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)

//smartstring.Base64
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'

// methods
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

smartstring.indent.indent('somestring\anotherstring', 4) // indents a string by 4
smartstring.indent.indent('somestring\anotherstring', '>>>> ') // indents a string with a prefix
smartstring.indent.normalize('    somestring\        anotherstring', '>>>> ') // looks for the least amount of indention and removes superflouous space

For further information read the linked docs at the top of this README.

MIT licensed | © Lossless GmbH

repo-footer