Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
@ui-autotools/registry
Advanced tools
allows creating/retriving code metdata descriptions.
creates/retrieves a metadata description object
arguments:
name | Type | description |
---|---|---|
entity | any | described entity |
type | "react" / "class" / "function" / "general" | type of described entity |
returns:
ReactDescription, ClassDescription, FunctionDescription or GeneralDescription
allows reading/writing the different meta-data fields.
sets title of entity
arguments:
name | Type | description |
---|---|---|
title | string | ... |
sets description of entity
arguments:
name | Type | description |
---|---|---|
description | string | ... |
adds documentation in markdown format to entity
arguments:
name | Type | description |
---|---|---|
title | string | |
content | markdown string | documentation content |
sets JSONSchema of entity
arguments:
name | Type | description |
---|---|---|
schema | JSON schema |
adds browser tests to entity
arguments:
name | Type | description |
---|---|---|
title | string | |
testFile | method | dynamically imports test file |
myDesc.addBrowserTests('accesability' ()=>import('./accesability.spec.ts')
react description adds some extra field to the general description
sets type of react entity
arguments:
name | Type | description |
---|---|---|
type | "Component" / "FunctionComponent" / "JSX" |
adds prop simulation to component
arguments:
name | Type | description |
---|---|---|
title | string | |
props | component props |
adds cross cutting prop to all component simulations
arguments:
name | Type | description |
---|---|---|
title | string | |
propName | string | |
value | component prop value |
adds state simulation to component, usefull for getting the component into different visual states without user interaction. i.e. open in a drop down
arguments:
name | Type | description |
---|---|---|
title | string | |
state | partial component state |
adds constructor arguments simulation to class
arguments:
name | Type | description |
---|---|---|
title | string | |
args | array | constructor arguments |
adds arguments simulation to function
arguments:
name | Type | description |
---|---|---|
title | string | |
args | array | constructor arguments |
FAQs
allows creating/retriving code metdata descriptions.
The npm package @ui-autotools/registry receives a total of 5 weekly downloads. As such, @ui-autotools/registry popularity was classified as not popular.
We found that @ui-autotools/registry demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 7 open source maintainers collaborating on the project.
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.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.