validateString
Description
It resolves the supposedString parameter if it is of a string type.
| Parameter List | Returns | Rejection Errors |
|---|---|---|
| Promise<string || Array> | |
| Related Functions | Function Signature | |
function validateString(supposedString[, tuple]): Promise<string || Array> | ||
Examples
1
2
3
import { validateString } from "puddy-m/lib/validators";
validateString("foo").then(console.log); // prints 'foo'1
2
3
4
5
import { validateString } from "puddy-m/lib/validators";
validateString("fizz", [])
.then((tuple) => validateString("foo", tuple))
.then(console.log); // prints ['fizz', 'foo']1
2
3
4
5
6
7
8
9
10
11
12
13
14
import { validateString } from "puddy-m/lib/validators";
const run = async () => {
try {
const validString = await validateString('string');
console.log(validString); // prints 'string'
} catch (e) {
console.log(e);
}
};
run();1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import { validateString } from "puddy-m/lib/validators";
const run = async () => {
try {
const invalidString = await validateString(5555);
console.log(invalidString); // Will throw since arg is not a string
} catch (e) {
// Throws StringValidationError
console.log(e);
}
};
run();