-
-
Notifications
You must be signed in to change notification settings - Fork 216
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #831 from EltonLobo07/doc/add-rawCheckAsync-with-s…
…chema add `rawCheckAsync` & `RawCheckActionAsync` API refs
- Loading branch information
Showing
12 changed files
with
556 additions
and
123 deletions.
There are no files selected for viewing
21 changes: 21 additions & 0 deletions
21
website/src/routes/api/(actions)/rawCheck/AddIssue/index.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,21 @@ | ||
| --- | ||
| title: AddIssue | ||
| description: Add issue type. | ||
| contributors: | ||
| - EltonLobo07 | ||
| --- | ||
|
|
||
| import { Property } from '~/components'; | ||
| import { properties } from './properties'; | ||
|
|
||
| # AddIssue | ||
|
|
||
| Add issue type. | ||
|
|
||
| ## Generics | ||
|
|
||
| - `TInput` <Property {...properties.TInput} /> | ||
|
|
||
| ## Definition | ||
|
|
||
| - `AddIssue` <Property {...properties.AddIssue} /> |
31 changes: 31 additions & 0 deletions
31
website/src/routes/api/(actions)/rawCheck/AddIssue/properties.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,31 @@ | ||
| import type { PropertyProps } from '~/components'; | ||
|
|
||
| export const properties: Record<string, PropertyProps> = { | ||
| TInput: { | ||
| modifier: 'extends', | ||
| type: 'any', | ||
| }, | ||
| AddIssue: { | ||
| type: { | ||
| type: 'function', | ||
| params: [ | ||
| { | ||
| name: 'info', | ||
| optional: true, | ||
| type: { | ||
| type: 'custom', | ||
| name: 'IssueInfo', | ||
| href: '../IssueInfo/', | ||
| generics: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'TInput', | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| ], | ||
| return: 'void', | ||
| }, | ||
| }, | ||
| }; |
24 changes: 24 additions & 0 deletions
24
website/src/routes/api/(actions)/rawCheck/Context/index.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,24 @@ | ||
| --- | ||
| title: Context | ||
| description: Context type. | ||
| contributors: | ||
| - EltonLobo07 | ||
| --- | ||
|
|
||
| import { Property } from '~/components'; | ||
| import { properties } from './properties'; | ||
|
|
||
| # Context | ||
|
|
||
| Context type. | ||
|
|
||
| ## Generics | ||
|
|
||
| - `TInput` <Property {...properties.TInput} /> | ||
|
|
||
| ## Definition | ||
|
|
||
| - `Context` | ||
| - `dataset` <Property {...properties.dataset} /> | ||
| - `config` <Property {...properties.config} /> | ||
| - `addIssue` <Property {...properties.addIssue} /> |
60 changes: 60 additions & 0 deletions
60
website/src/routes/api/(actions)/rawCheck/Context/properties.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,60 @@ | ||
| import type { PropertyProps } from '~/components'; | ||
|
|
||
| export const properties: Record<string, PropertyProps> = { | ||
| TInput: { | ||
| modifier: 'extends', | ||
| type: 'any', | ||
| }, | ||
| dataset: { | ||
| type: { | ||
| type: 'custom', | ||
| name: 'Dataset', | ||
| href: '../../Dataset/', | ||
| generics: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'TInput', | ||
| }, | ||
| { | ||
| type: 'custom', | ||
| name: 'BaseIssue', | ||
| href: '../../BaseIssue/', | ||
| generics: ['unknown'], | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| config: { | ||
| type: { | ||
| type: 'custom', | ||
| name: 'Config', | ||
| href: '../../Config/', | ||
| generics: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'RawCheckIssue', | ||
| href: '../../RawCheckIssue/', | ||
| generics: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'TInput', | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| addIssue: { | ||
| type: { | ||
| type: 'custom', | ||
| name: 'AddIssue', | ||
| href: '../AddIssue/', | ||
| generics: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'TInput', | ||
| }, | ||
| ], | ||
| }, | ||
| }, | ||
| }; |
27 changes: 27 additions & 0 deletions
27
website/src/routes/api/(actions)/rawCheck/IssueInfo/index.mdx
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,27 @@ | ||
| --- | ||
| title: IssueInfo | ||
| description: Issue info type. | ||
| contributors: | ||
| - EltonLobo07 | ||
| --- | ||
|
|
||
| import { Property } from '~/components'; | ||
| import { properties } from './properties'; | ||
|
|
||
| # IssueInfo | ||
|
|
||
| Issue info type. | ||
|
|
||
| ## Generics | ||
|
|
||
| - `TInput` <Property {...properties.TInput} /> | ||
|
|
||
| ## Definition | ||
|
|
||
| - `IssueInfo` | ||
| - `label` <Property {...properties.label} /> | ||
| - `input` <Property {...properties.input} /> | ||
| - `expected` <Property {...properties.expected} /> | ||
| - `received` <Property {...properties.received} /> | ||
| - `message` <Property {...properties.message} /> | ||
| - `path` <Property {...properties.path} /> |
91 changes: 91 additions & 0 deletions
91
website/src/routes/api/(actions)/rawCheck/IssueInfo/properties.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,91 @@ | ||
| import type { PropertyProps } from '~/components'; | ||
|
|
||
| export const properties: Record<string, PropertyProps> = { | ||
| TInput: { | ||
| modifier: 'extends', | ||
| type: 'any', | ||
| }, | ||
| kind: { | ||
| type: { | ||
| type: 'string', | ||
| value: 'metadata', | ||
| }, | ||
| }, | ||
| label: { | ||
| type: { | ||
| type: 'union', | ||
| options: ['string', 'undefined'], | ||
| }, | ||
| }, | ||
| input: { | ||
| type: { | ||
| type: 'union', | ||
| options: ['unknown', 'undefined'], | ||
| }, | ||
| }, | ||
| expected: { | ||
| type: { | ||
| type: 'union', | ||
| options: ['string', 'undefined'], | ||
| }, | ||
| }, | ||
| received: { | ||
| type: { | ||
| type: 'union', | ||
| options: ['string', 'undefined'], | ||
| }, | ||
| }, | ||
| message: { | ||
| type: { | ||
| type: 'union', | ||
| options: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'ErrorMessage', | ||
| href: '../../ErrorMessage/', | ||
| generics: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'RawCheckIssue', | ||
| href: '../../RawCheckIssue/', | ||
| generics: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'TInput', | ||
| }, | ||
| ], | ||
| }, | ||
| ], | ||
| }, | ||
| 'undefined', | ||
| ], | ||
| }, | ||
| }, | ||
| path: { | ||
| type: { | ||
| type: 'union', | ||
| options: [ | ||
| { | ||
| type: 'tuple', | ||
| items: [ | ||
| { | ||
| type: 'custom', | ||
| name: 'IssuePathItem', | ||
| href: '../../IssuePathItem/', | ||
| }, | ||
| { | ||
| type: 'array', | ||
| item: { | ||
| type: 'custom', | ||
| name: 'IssuePathItem', | ||
| href: '../../IssuePathItem/', | ||
| }, | ||
| spread: true, | ||
| }, | ||
| ], | ||
| }, | ||
| 'undefined', | ||
| ], | ||
| }, | ||
| }, | ||
| }; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.