No Description

Sven Slootweg eaab22314e 1.0.0 4 days ago
.gitignore 9dd8723144 Initial commit 2 months ago
README.md 86610c1e72 Add documentation 4 days ago
example.js 96e2c401e2 Add missing @validatem/core devDependency 2 months ago
index.js 8458b93461 Add error code 4 days ago
package.json eaab22314e 1.0.0 4 days ago
yarn.lock 96e2c401e2 Add missing @validatem/core devDependency 2 months ago

README.md

@validatem/is-string

This validator is designed to be used with Validatem, the universal and composable validation library.

Validates that a given input is a string.

Note that it does not validate that the string is non-empty (ie. has a length above 0); for that, you should use @validatem/is-non-empty-string instead.

License, donations, and other boilerplate

Licensed under either the WTFPL or CC0, at your choice. In practice, that means it's more or less public domain, and you can do whatever you want with it. Giving credit is not required, but still very much appreciated! I'd love to hear from you if this module was useful to you.

Creating and maintaining open-source modules is a lot of work. A donation is also not required, but much appreciated! You can donate here.

Example

A runnable version of this example is included in the repository, as example.js.

"use strict";

const { validateValue } = require("@validatem/core");
const isString = require("@validatem/is-string");

console.log(validateValue("hello world", [ isString ])); // hello world

console.log(validateValue(42, [ isString ])); /*
	AggregrateValidationError: One or more validation errors occurred:
	- At (root): Must be a string
*/

API

If you are new to Validatem, please read the documentation on the Validatem website first - it will explain how the general API works, and how you should use validator modules with it.

isString

Not callable. Validates that the input is a string. When validation passes, it returns the original string as-is.

Possible error codes:

  • validatem.is-string: The input was not a string.

Changelog

1.0.0 (August 8, 2020)

Initial release.