TypeDoc generated docs in here
utils for strings
- initials
initials([string=''])
Returns the first character of each space seperated word in the given string.
[string=''] (string): The string to convert to initials.
(string): Returns the converted string
initials('foo bar doe');
// => 'f b d'
See documentation for development
See The Typescript-Starter docs.
For commits, you should use commitizen
npm install -g commitizen
# commit your changes:
git czAs typescript-starter docs state:
This project is tooled for conventional changelog to make managing releases easier. See the standard-version documentation for more information on the workflow, or CHANGELOG.md for an example.
# bump package.json version, update CHANGELOG.md, git tag the release
npm run versionYou may find a tool like wip helpful for managing work in progress before you're ready to create a meaningful commit.
Once you are ready to create the first version, run the following (note that reset is destructive and will remove all files not in the git repo from the directory).
# Reset the repo to the latest commit and build everything
npm run reset && npm run test
# Then version it with standard-version options. e.g.:
# don't bump package.json version
npm run version -- --first-release
# Other popular options include:
# PGP sign it:
# $ npm run version -- --sign
# alpha release:
# $ npm run version -- --prerelease alphaAnd finally push the new tags to Github and publish the package to npm.
# Push to git
git push --follow-tags origin master
# Publish to NPM (allowing public access, required if the package name is namespaced like `@somewhere/some-lib`)
npm publish --access publicThere is a single command for preparing a new release:
# Prepare a standard release
npm run prepare-release
# Push to git
git push --follow-tags origin master
# Publish to NPM (allowing public access, required if the package name is namespaced like `@somewhere/some-lib`)
npm publish --access public