The purpose of the ink-strings library is to gather up the best of the available string libraries and edit them into a single, somewhat cohesive whole that runs on server and client. This includes components and bit and pieces of each of these excellent tools:
And a few others, see the NOTICES.md file for details on the licenses for the tools being used.
npm install ink-strings
From node: var strings = require("ink-strings");
On the web:
dist/ink.strings.min.js to your assets directory and then load it directly
<script src="js/ink.strings.js"></script> <script> // all of the methods hang right off of window.ink.strings var goHome = ink.strings.repeat("there's no place like home", 3); </script>
ink-strings comes with a pretty big set of methods and a few classes. The documentation is broken up by category, but all methods
are published from the main
- Generating Strings
- Base64 Encoding/Decoding
- Shaping and Manipulating Strings
- Interrogating Strings to see what they are made of
- HTML Tags
- Binary Strings
- RegEx Pattern Library
Yes! Contribute. Make sure your code looks essentially like the code you see. Document using JSDoc tags.
- ink-scene (coming soon)
- ink-dox (coming, but a long way off yet)
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Portions covered by the Apache Licence Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.