Start9/start-sdk
2
0
Fork 0
mirror of https://github.com/Start9Labs/start-sdk.git synced 2026-03-26 02:11:56 +00:00
Code Issues Packages Projects Releases Wiki Activity

add metadata to exported values for display in properties

Browse Source
This commit is contained in:
Matt Hill
2023-09-15 10:48:23 -06:00
parent b09e7bb94d
commit 17f647115b
1 changed files with 11 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
lib/types.ts
View File

@@ -201,16 +201,23 @@ export type ExposeAllUiPaths<Store, PreviousPath extends string = ""> =
Store extends string ? PreviousPath :
never
export type ExposeServicePaths<Store> = Array<{
/** Sets the value for the wrapper at the path, it will override, using the [JsonPath](https://jsonpath.com/) */
/** The path to the value in the Store. [JsonPath](https://jsonpath.com/) */
path: ExposeAllServicePaths<Store>
}>
export type ExposeUiPaths<Store> = Array<{
/** Sets the value for the wrapper at the path, it will override, using the [JsonPath](https://jsonpath.com/) */
/** The path to the value in the Store. [JsonPath](https://jsonpath.com/) */
path: ExposeAllUiPaths<Store>
/** This will be the title for the value field that is returned */
/** A human readable title for the value */
title: string
/** A human readable description or explanation of the value */
description?: string
/** (string/number only) Whether or not to mask the value, for example, when displaying a password */
masked?: boolean
/** (string/number only) Whether or not to include a button for copying the value to clipboard */
copyable?: boolean
/** (string/number only) Whether or not to include a button for displaying the value as a QR code */
qr?: boolean
}>
/** Used to reach out from the pure js runtime */
export type Effects = {