Socket
Socket
Sign inDemoInstall

@qgustavor/ass-parser

Package Overview
Dependencies
0
Maintainers
1
Versions
6
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @qgustavor/ass-parser

Parse SSA/ASS subtitle format


Version published
Maintainers
1
Install size
7.59 kB
Created

Readme

Source

ass-parser

Parse SSA/ASS subtitle format. Forked from eush77/ass-parser.

Changes:

  • All dependencies replaced with native modern JavaScript functions.
  • ES Modules instead of CommonJS.
  • Add detectStringifyOptions helper function.

Demo

https://codepen.io/qgustavor/full/YzaRXeX

API

assParser(text, [options])

Default export. Returns the parse tree.

Comments are ignored unless options.comments is set.

OptionTypeRequired?Default
commentsbooleanNofalse
parseTimestampsbooleanNofalse

Format

Subtitle is a list of sections, each of them has section, body and line properties. The body is a list of key-value bindings (descriptors), with key, value and line properties (type === 'comment' and value for comments).

value can be one of the following:

  • array if the descriptor key is "Format";
  • object if there is a "Format" descriptor above in the section;
  • string otherwise.

When parseTimestamps is set to true timestamps on Start and End keys for Dialogue and Comment lines will be converted into numbers (in seconds).

At the moment override tags are not parsed. One alternative is parsing using libjass like so: libjass.parser.parse(descriptor.value.Text, 'dialogueParts').

The line property in sections and descriptors refer to the 0-indexed line where the section or descriptor was defined in the text.

detectStringifyOptions(text)

Named export. Returns an options object to be passed to stringify in order to parse then stringify a subtitle with the minimal differences possible.

References

Install

npm install @qgustavor/ass-parser

License

MIT

Keywords

FAQs

Last updated on 12 Jul 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