diff options
author | Atakan Ermiş <ataerms@gmail.com> | 2020-10-03 17:44:08 +0300 |
---|---|---|
committer | GitHub <noreply@github.com> | 2020-10-03 16:44:08 +0200 |
commit | 920c0b35153cd8058165125ba0af228416835e67 (patch) | |
tree | 588b626d489e2b30b0bcab1a171d6ab3888999e6 /std/encoding | |
parent | f9973364ddcb784b9514dbed025f793415c263cb (diff) |
docs(std/encoding): add missing JSDoc (#7809)
Diffstat (limited to 'std/encoding')
-rw-r--r-- | std/encoding/hex.ts | 5 | ||||
-rw-r--r-- | std/encoding/toml.ts | 8 |
2 files changed, 13 insertions, 0 deletions
diff --git a/std/encoding/hex.ts b/std/encoding/hex.ts index 5b09422a9..20d42f657 100644 --- a/std/encoding/hex.ts +++ b/std/encoding/hex.ts @@ -7,6 +7,10 @@ const hextable = new TextEncoder().encode("0123456789abcdef"); +/** + * ErrInvalidByte takes an invalid byte and returns an Error. + * @param byte + */ export function errInvalidByte(byte: number): Error { return new Error( "encoding/hex: invalid byte: " + @@ -14,6 +18,7 @@ export function errInvalidByte(byte: number): Error { ); } +/** ErrLength returns an error about odd string length. */ export function errLength(): Error { return new Error("encoding/hex: odd length hex string"); } diff --git a/std/encoding/toml.ts b/std/encoding/toml.ts index 62acc7db7..86ee0bdeb 100644 --- a/std/encoding/toml.ts +++ b/std/encoding/toml.ts @@ -636,10 +636,18 @@ class Dumper { } } +/** + * Stringify dumps source object into TOML string and returns it. + * @param srcObj + */ export function stringify(srcObj: Record<string, unknown>): string { return new Dumper(srcObj).dump().join("\n"); } +/** + * Parse parses TOML string into an object. + * @param tomlString + */ export function parse(tomlString: string): Record<string, unknown> { // File is potentially using EOL CRLF tomlString = tomlString.replace(/\r\n/g, "\n").replace(/\\\n/g, "\n"); |