mirror of
https://github.com/oven-sh/bun
synced 2026-02-09 10:28:47 +00:00
add Bun.YAML.parse to types (#22129)
This commit is contained in:
27
packages/bun-types/bun.d.ts
vendored
27
packages/bun-types/bun.d.ts
vendored
@@ -619,6 +619,33 @@ declare module "bun" {
|
||||
export function parse(input: string): object;
|
||||
}
|
||||
|
||||
/**
|
||||
* YAML related APIs
|
||||
*/
|
||||
namespace YAML {
|
||||
/**
|
||||
* Parse a YAML string into a JavaScript value
|
||||
*
|
||||
* @category Utilities
|
||||
*
|
||||
* @param input The YAML string to parse
|
||||
* @returns A JavaScript value
|
||||
*
|
||||
* @example
|
||||
* ```ts
|
||||
* import { YAML } from "bun";
|
||||
*
|
||||
* console.log(YAML.parse("123")) // 123
|
||||
* console.log(YAML.parse("123")) // null
|
||||
* console.log(YAML.parse("false")) // false
|
||||
* console.log(YAML.parse("abc")) // "abc"
|
||||
* console.log(YAML.parse("- abc")) // [ "abc" ]
|
||||
* console.log(YAML.parse("abc: def")) // { "abc": "def" }
|
||||
* ```
|
||||
*/
|
||||
export function parse(input: string): unknown;
|
||||
}
|
||||
|
||||
/**
|
||||
* Synchronously resolve a `moduleId` as though it were imported from `parent`
|
||||
*
|
||||
|
||||
5
test/integration/bun-types/fixture/yaml.ts
Normal file
5
test/integration/bun-types/fixture/yaml.ts
Normal file
@@ -0,0 +1,5 @@
|
||||
import { expectType } from "./utilities";
|
||||
|
||||
expectType(Bun.YAML.parse("")).is<unknown>();
|
||||
// @ts-expect-error
|
||||
expectType(Bun.YAML.parse({})).is<unknown>();
|
||||
Reference in New Issue
Block a user