Skip to content

Commit

Permalink
Cut release
Browse files Browse the repository at this point in the history
  • Loading branch information
natoverse committed Apr 25, 2023
1 parent 1a3e2f6 commit 9957556
Show file tree
Hide file tree
Showing 5 changed files with 137 additions and 2 deletions.
21 changes: 21 additions & 0 deletions packages/components/docs/markdown/components.datatype.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@essex/components](./components.md) &gt; [DataType](./components.datatype.md)

## DataType enum

<b>Signature:</b>

```typescript
export declare enum DataType
```

## Enumeration Members

| Member | Value | Description |
| --- | --- | --- |
| Array | <code>&quot;array&quot;</code> | |
| Boolean | <code>&quot;boolean&quot;</code> | |
| Number | <code>&quot;number&quot;</code> | |
| String | <code>&quot;string&quot;</code> | |

1 change: 1 addition & 0 deletions packages/components/docs/markdown/components.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@
| --- | --- |
| [ControlType](./components.controltype.md) | Type of control you'd like rendered for a setting. This uses traditional names but maps to controls available in the Fluent control set. E.g., 'textbox' is a Textfield. |
| [CookieConsentCategories](./components.cookieconsentcategories.md) | |
| [DataType](./components.datatype.md) | |

## Functions

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,5 +20,5 @@ export interface SettingConfig
| [defaultValue?](./components.settingconfig.defaultvalue.md) | | any | <i>(Optional)</i> Default value of the setting. |
| [label?](./components.settingconfig.label.md) | | string | <i>(Optional)</i> Custom label to use instead of deriving from the setting key. |
| [params?](./components.settingconfig.params.md) | | [ControlParams](./components.controlparams.md) | <i>(Optional)</i> Deeper params for controls that may need extra config (e.g., numeric bounds). |
| [type?](./components.settingconfig.type.md) | | DataType | <i>(Optional)</i> Explicitly set the data type, overriding typeof. Useful when the default value is undefined so type cannot be inferred. |
| [type?](./components.settingconfig.type.md) | | [DataType](./components.datatype.md) | <i>(Optional)</i> Explicitly set the data type, overriding typeof. Useful when the default value is undefined so type cannot be inferred. |

100 changes: 100 additions & 0 deletions packages/components/docs/report/components.api.json
Original file line number Diff line number Diff line change
Expand Up @@ -2099,6 +2099,106 @@
}
]
},
{
"kind": "Enum",
"canonicalReference": "@essex/components!DataType:enum",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "export declare enum DataType "
}
],
"releaseTag": "Public",
"name": "DataType",
"preserveMemberOrder": false,
"members": [
{
"kind": "EnumMember",
"canonicalReference": "@essex/components!DataType.Array:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "Array = "
},
{
"kind": "Content",
"text": "\"array\""
}
],
"initializerTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"name": "Array"
},
{
"kind": "EnumMember",
"canonicalReference": "@essex/components!DataType.Boolean:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "Boolean = "
},
{
"kind": "Content",
"text": "\"boolean\""
}
],
"initializerTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"name": "Boolean"
},
{
"kind": "EnumMember",
"canonicalReference": "@essex/components!DataType.Number:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "Number = "
},
{
"kind": "Content",
"text": "\"number\""
}
],
"initializerTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"name": "Number"
},
{
"kind": "EnumMember",
"canonicalReference": "@essex/components!DataType.String:member",
"docComment": "",
"excerptTokens": [
{
"kind": "Content",
"text": "String = "
},
{
"kind": "Content",
"text": "\"string\""
}
],
"initializerTokenRange": {
"startIndex": 1,
"endIndex": 2
},
"releaseTag": "Public",
"name": "String"
}
]
},
{
"kind": "Variable",
"canonicalReference": "@essex/components!defaultBannerLinks:var",
Expand Down
15 changes: 14 additions & 1 deletion packages/components/docs/report/components.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,20 @@ export type CookieConsentManager = {
manageConsent(): void;
};

// Warning: (ae-missing-release-tag) "DataType" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
export enum DataType {
// (undocumented)
Array = "array",
// (undocumented)
Boolean = "boolean",
// (undocumented)
Number = "number",
// (undocumented)
String = "string"
}

// Warning: (ae-missing-release-tag) "defaultBannerLinks" is exported by the package, but it is missing a release tag (@alpha, @beta, @public, or @internal)
//
// @public (undocumented)
Expand Down Expand Up @@ -441,7 +455,6 @@ export interface SettingConfig {
defaultValue?: any;
label?: string;
params?: ControlParams;
// Warning: (ae-forgotten-export) The symbol "DataType" needs to be exported by the entry point index.d.ts
type?: DataType;
}

Expand Down

0 comments on commit 9957556

Please sign in to comment.