@types/spdx-expression-parse

  • Version 4.0.0
  • Published
  • 3.53 kB
  • No dependencies
  • MIT license

Install

npm i @types/spdx-expression-parse
yarn add @types/spdx-expression-parse
pnpm add @types/spdx-expression-parse

Overview

TypeScript definitions for spdx-expression-parse

Index

Functions

function parse

parse: (source: string) => parse.Info;
  • This package parses SPDX license expression strings describing license terms, like package.json license strings, into consistently structured ECMAScript object

Interfaces

interface ConjunctionInfo

interface ConjunctionInfo {}

    property conjunction

    conjunction: 'and' | 'or';

      property left

      left: LicenseInfo | ConjunctionInfo;

        property right

        right: LicenseInfo | ConjunctionInfo;

          interface LicenseInfo

          interface LicenseInfo {}

            property exception

            exception?: string | undefined;

              property license

              license: string;

                property plus

                plus?: true | undefined;

                  interface Token

                  interface Token {}

                    property string

                    string: string;

                      property type

                      type: 'OPERATOR' | 'LICENSE' | 'DOCUMENTREF' | 'LICENSEREF' | 'EXCEPTION';

                        Type Aliases

                        type Info

                        type Info = LicenseInfo | ConjunctionInfo;

                          Package Files (1)

                          Dependencies (0)

                          No dependencies.

                          Dev Dependencies (0)

                          No dev dependencies.

                          Peer Dependencies (0)

                          No peer dependencies.

                          Badge

                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/@types/spdx-expression-parse.

                          • Markdown
                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/@types/spdx-expression-parse)
                          • HTML
                            <a href="https://www.jsdocs.io/package/@types/spdx-expression-parse"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>