denoland / deno_std

The Deno Standard Library
https://jsr.io/@std
MIT License
2.83k stars 581 forks source link

BREAKING(yaml): rename `DumpOptions` to `StringifyOptions` #5171

Closed kt3k closed 5 days ago

kt3k commented 5 days ago

DumpOptions is the options for stringify. This should be named StringifyOptions

What's changed

DumpOptions has been renamed to StringifyOptions

Motivation

The current name isn't aligned to the naming convention of the option types because it's options for stringify. There's no public API called dump.

Migration

-import type { DumpOptions } from "@std/yaml`;
+import type { StringifyOptions as DumpOptions } from "@std/yaml`;
codecov[bot] commented 5 days ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 93.34%. Comparing base (ef4231e) to head (fd35d61). Report is 3 commits behind head on main.

Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #5171 +/- ## ========================================== - Coverage 93.34% 93.34% -0.01% ========================================== Files 470 470 Lines 37941 37939 -2 Branches 5391 5391 ========================================== - Hits 35416 35414 -2 Misses 2482 2482 Partials 43 43 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.