https://github.com/bennypowers/package-info
Web component that displays npm dependency info
https://github.com/bennypowers/package-info
custom-elements hacktoberfest license npm web-components
Last synced: 2 months ago
JSON representation
Web component that displays npm dependency info
- Host: GitHub
- URL: https://github.com/bennypowers/package-info
- Owner: bennypowers
- License: isc
- Created: 2020-07-28T19:06:58.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2023-10-05T18:39:18.000Z (over 2 years ago)
- Last Synced: 2025-10-19T12:56:17.575Z (8 months ago)
- Topics: custom-elements, hacktoberfest, license, npm, web-components
- Language: TypeScript
- Homepage:
- Size: 833 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# `index.js`:
## Exports
| kind | name | declaration | module | package |
|------|-----------|-------------|--------|---------|
|js |* |* | | ./package-author |[object Object] | | |
|js |* |* | | ./package-info |[object Object] | | |
# `licenses.js`:
## Exports
| kind | name | declaration | module | package |
|------|-----------|-------------|--------|---------|
|js |default | | licenses.js | |[object Object] | | |
# `package-author.js`:
## class: `PackageAuthor`, `package-author`
### Superclass
| name | module | package |
|------|--------|---------|
|LitElement | | |
### Fields
| name | type | privacy | default | description | inheritedFrom |
|------|------|---------|---------|-------------|---------------|
|is | | |package-author | | | |
|name |string | | | | | |
|email |string | | | | | |
|url |string | | | | | |
### Attributes
| name | fieldName | inheritedFrom |
|------|-----------|---------------|
|name |name | | |
|email |email | | |
|url |url | | |
### CSS Properties
| name | description |
|------|-----------|
|--software-license-link-color |- link color |
## Exports
| kind | name | declaration | module | package |
|------|-----------|-------------|--------|---------|
|js |PackageAuthor |PackageAuthor | package-author.js | |[object Object] | | |
|custom-element-definition |package-author |PackageAuthor | package-author.js | |[object Object] | | |
# `package-dependencies.js`:
## class: `PackageDependencies`, `package-dependencies`
### Superclass
| name | module | package |
|------|--------|---------|
|LitElement | | |
### Fields
| name | type | privacy | default | description | inheritedFrom |
|------|------|---------|---------|-------------|---------------|
|is | | |package-dependencies | | | |
|src | | | |URL to the dependencies JSON file | | |
|dependencies |Package[] |private | | | | |
### Methods
| name | privacy | description | parameters | return | inheritedFrom |
|------|---------|-------------|------------|--------|---------------|
|fetch |private | |src |Promise | | |
### Attributes
| name | fieldName | inheritedFrom |
|------|-----------|---------------|
|src |src | | |
## Exports
| kind | name | declaration | module | package |
|------|-----------|-------------|--------|---------|
|js |PackageDependencies |PackageDependencies | package-dependencies.js | |[object Object] | | |
|custom-element-definition |package-dependencies |PackageDependencies | package-dependencies.js | |[object Object] | | |
# `package-info.js`:
## class: `PackageInfo`, `package-info`
### Superclass
| name | module | package |
|------|--------|---------|
|LitElement | | |
### Fields
| name | type | privacy | default | description | inheritedFrom |
|------|------|---------|---------|-------------|---------------|
|is | | |package-info | | | |
|collapsible | | | |When true, only the name is initially shown | | |
|name |string | | |Package Name | | |
|version |string | | |Package Version | | |
|description |string | | |Package Description | | |
|homepage |string | | |Package Homepage | | |
|license |string | | |SPDX License Name | | |
|licenseText |string | | |License Text. Maybe also be slotted into `license` slot | | |
|contributors |Author[] | | |Package Contributors | | |
|maintainers |Author[] | | |Package Maintainers | | |
|author |Author | | |Package Author | | |
|repository |Repository | | |Package Repository | | |
### Attributes
| name | fieldName | inheritedFrom |
|------|-----------|---------------|
|collapsible |collapsible | | |
|name |name | | |
|version |version | | |
|description |description | | |
|homepage |homepage | | |
|license |license | | |
|author |author | | |
|repository |repository | | |
### Slots
| name | description |
|------|-----------|
|author |- Software Author. `` element preferred |
|description |- Package description. takes a `
` element |
|maintainer |- Software maintainers. takes a `` element or `
` of such |
|contributor |- Software contributors. takes a `` element of `` of such |
|license |- License. e.g. `` or formatted license HTML |
## Exports
| kind | name | declaration | module | package |
|------|-----------|-------------|--------|---------|
|js |PackageInfo |PackageInfo | package-info.js | |[object Object] | | |
|custom-element-definition |package-info |PackageInfo | package-info.js | |[object Object] | | |