Socket
Socket
Sign inDemoInstall

@types/js-yaml

Package Overview
Dependencies
0
Maintainers
1
Versions
44
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

@types/js-yaml

TypeScript definitions for js-yaml


Version published
Maintainers
1
Weekly downloads
4,504,401
decreased by-5.36%

Weekly downloads

Package description

What is @types/js-yaml?

The @types/js-yaml package provides TypeScript type definitions for the js-yaml package, which is a YAML parser and serializer. This allows developers using TypeScript to work with js-yaml more effectively by providing compile-time type checking and IntelliSense support in code editors. The main functionalities include parsing YAML strings into JavaScript objects and serializing JavaScript objects into YAML strings.

What are @types/js-yaml's main functionalities?

Parsing YAML to JavaScript Object

This feature allows you to parse a YAML string into a JavaScript object. It's useful for reading configuration files or data serialization formats that are easier to read and write for humans than JSON.

import * as yaml from 'js-yaml';
let doc = yaml.load('foo: bar');
console.log(doc); // Outputs: { foo: 'bar' }

Serializing JavaScript Object to YAML

This feature enables you to serialize a JavaScript object into a YAML string. It's beneficial for generating configuration files or data serialization formats that need to be human-readable.

import * as yaml from 'js-yaml';
let obj = { foo: 'bar' };
let yml = yaml.dump(obj);
console.log(yml); // Outputs YAML string representation of the object

Other packages similar to @types/js-yaml

Readme

Source

Installation

npm install --save @types/js-yaml

Summary

This package contains type definitions for js-yaml (https://github.com/nodeca/js-yaml).

Details

Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/js-yaml.

Additional Details

  • Last updated: Tue, 07 Nov 2023 20:08:00 GMT
  • Dependencies: none

Credits

These definitions were written by Bart van der Schoor, Sebastian Clausen, ExE Boss, Armaan Tobaccowalla, and Linus Unnebäck.

FAQs

Last updated on 07 Nov 2023

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc