spiegel-keyman/web/docs/engine/reference/util/toNumber.md
Marc Durdin 1f82507730 docs(web): deprecate unused and obsolete API endpoints and docs cleanup
Deprecate the following obsolete functions and properties:
* `keyman.helpURL`
* `keyman.util.rgba`
* `keyman.util.toFloat`
* `keyman.util.toNumber`
* `keyman.util.toNzString`

Use correct language for code blocks in Keyman Engine for Web
documentation.

Test-bot: skip
2026-08-12 16:07:22 +02:00

40 lines
662 B
Markdown

---
title: toNumber (deprecated)
---
## Summary
String -> number conversion, with default.
## Syntax
```js
keyman.util.toNumber(s, dflt);
```
### Parameters
`s`
: Type: `string`
: Numeric string.
`dflt`
: Type: `number`
: Default value if parse is unsuccessful.
### Return Value
`number`
: The string's conversion to a whole-number numeric value, or the default value if unsuccessful.
## Description
This is a simple wrapper around `parseInt(s, 10)` to handle invalid inputs, for which
`dflt` will be returned instead.
This function has been deprecated and will be removed in a future version of
KeymanWeb.
## History
19.0: deprecated