Socket
Socket
Sign inDemoInstall

@agrarium/plugin-dts

Package Overview
Dependencies
52
Maintainers
2
Versions
2
Alerts
File Explorer

Advanced tools

Install Socket

Detect and block malicious and high-risk dependencies

Install

    @agrarium/plugin-dts

Agrarium plugin for types definitions resolving


Version published
Weekly downloads
4
increased by300%
Maintainers
2
Install size
47.3 MB
Created
Weekly downloads
 

Readme

Source

Agrarium Types Definitions Plugin

Agrarium plugin for types definitions resolving. It parses *.d.ts files to data.dts key in result.

Usage

npm i agrarium

Or use it standalone:

npm i @agrarium/plugin-dts

In your .agrarium.js file:

const { PluginDTS } = require('agrarium');

module.exports = {
    src: ['./src/components'],
    plugins: [
        new DTS()
    ]
};

Example of result data

console.log(chunk.data)

{
    dts: {
        name: 'TestBlock',
        sources: [{
            fileName: 'common/test-block/_mod/test-block_mod.d.ts',
            line: 1,
            character: 26,
            cell: {
                entity: { block: 'test-block', mod: { name: 'mod', val: true } },
                tech: 'd.ts'
            }
        }],
        attributes: [{
            name: 'answer',
            type: 'boolean|string',
            description: 'Description for answer attribute extension'
        }],
        methods: [{
            name: 'onClick',
            type: 'void',
            description: 'Different signature for onClick',
            params: [
                { name: 'e', type: 'object', description: 'dom event' },
                { name: 'data', type: 'object', description: 'event data\n' }
            ]
        }, {
            name: 'onExit',
            type: 'void',
            description: 'Yet another one method'
        }]
    }
}

More examples in specs.

License MIT

FAQs

Last updated on 02 Apr 2018

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