Skip to content

Commit

Permalink
fix: tests and add missing docs
Browse files Browse the repository at this point in the history
  • Loading branch information
SkeLLLa committed Jan 22, 2025
1 parent e88dc12 commit 1c102ca
Show file tree
Hide file tree
Showing 20 changed files with 1,061 additions and 515 deletions.
43 changes: 43 additions & 0 deletions docs/api/pinot-noir.bypassparser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [BypassParser](./pinot-noir.bypassparser.md)

## BypassParser class

Bypass parser.

**Signature:**

```typescript
export declare class BypassParser implements IPinotValueParser
```
**Implements:** [IPinotValueParser](./pinot-noir.ipinotvalueparser.md)
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[parse(value)](./pinot-noir.bypassparser.parse.md)
</td><td>
</td><td>
Parses the value.
</td></tr>
</tbody></table>
48 changes: 48 additions & 0 deletions docs/api/pinot-noir.bypassparser.parse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [BypassParser](./pinot-noir.bypassparser.md) &gt; [parse](./pinot-noir.bypassparser.parse.md)

## BypassParser.parse() method

Parses the value.

**Signature:**

```typescript
parse(value?: number | string | boolean | object | null): number | string | boolean | object | null | undefined;
```

## Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

value

</td><td>

number \| string \| boolean \| object \| null

</td><td>

_(Optional)_ value to parse

</td></tr>
</tbody></table>
**Returns:**

number \| string \| boolean \| object \| null \| undefined

parsed value
35 changes: 35 additions & 0 deletions docs/api/pinot-noir.ipinotvalueparser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IPinotValueParser](./pinot-noir.ipinotvalueparser.md)

## IPinotValueParser interface

Pinot value parser interface.

**Signature:**

```typescript
export interface IPinotValueParser
```

## Methods

<table><thead><tr><th>

Method

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

[parse(value, type)](./pinot-noir.ipinotvalueparser.parse.md)

</td><td>

Parses the value.

</td></tr>
</tbody></table>
61 changes: 61 additions & 0 deletions docs/api/pinot-noir.ipinotvalueparser.parse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [IPinotValueParser](./pinot-noir.ipinotvalueparser.md) &gt; [parse](./pinot-noir.ipinotvalueparser.parse.md)

## IPinotValueParser.parse() method

Parses the value.

**Signature:**

```typescript
parse(value?: number | string | boolean | object | null | Date, type?: TPinotDataType): number | string | boolean | object | null | Date | bigint | undefined;
```

## Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

value

</td><td>

number \| string \| boolean \| object \| null \| Date

</td><td>

_(Optional)_ value to parse

</td></tr>
<tr><td>

type

</td><td>

[TPinotDataType](./pinot-noir.tpinotdatatype.md)

</td><td>

_(Optional)_ value type

</td></tr>
</tbody></table>
**Returns:**

number \| string \| boolean \| object \| null \| Date \| bigint \| undefined

parsed value
36 changes: 36 additions & 0 deletions docs/api/pinot-noir.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,15 @@ Description
</th></tr></thead>
<tbody><tr><td>

[BypassParser](./pinot-noir.bypassparser.md)

</td><td>

Bypass parser.

</td></tr>
<tr><td>

[PinotBrokerClient](./pinot-noir.pinotbrokerclient.md)

</td><td>
Expand All @@ -42,6 +51,15 @@ Pinot broker JSON transport based on "undici" HTTP client.
</td></tr>
<tr><td>

[SafeParser](./pinot-noir.safeparser.md)

</td><td>

Safe parser.

</td></tr>
<tr><td>

[SqlFormat](./pinot-noir.sqlformat.md)

</td><td>
Expand All @@ -55,6 +73,15 @@ Pinot broker JSON transport based on "undici" HTTP client.

Sql utils class.

</td></tr>
<tr><td>

[UnsafeParser](./pinot-noir.unsafeparser.md)

</td><td>

Unsafe parser.

</td></tr>
</tbody></table>

Expand Down Expand Up @@ -293,6 +320,15 @@ Apache Pinot exception
</td></tr>
<tr><td>

[IPinotValueParser](./pinot-noir.ipinotvalueparser.md)

</td><td>

Pinot value parser interface.

</td></tr>
<tr><td>

[IQueryResult](./pinot-noir.iqueryresult.md)

</td><td>
Expand Down
43 changes: 43 additions & 0 deletions docs/api/pinot-noir.safeparser.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [SafeParser](./pinot-noir.safeparser.md)

## SafeParser class

Safe parser.

**Signature:**

```typescript
export declare class SafeParser implements IPinotValueParser
```
**Implements:** [IPinotValueParser](./pinot-noir.ipinotvalueparser.md)
## Methods
<table><thead><tr><th>
Method
</th><th>
Modifiers
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[parse(value, type)](./pinot-noir.safeparser.parse.md)
</td><td>
</td><td>
Parses the value.
</td></tr>
</tbody></table>
61 changes: 61 additions & 0 deletions docs/api/pinot-noir.safeparser.parse.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,61 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [pinot-noir](./pinot-noir.md) &gt; [SafeParser](./pinot-noir.safeparser.md) &gt; [parse](./pinot-noir.safeparser.parse.md)

## SafeParser.parse() method

Parses the value.

**Signature:**

```typescript
parse(value?: number | string | boolean | object | null, type?: TPinotDataType): number | string | boolean | object | null | bigint | Date | undefined;
```

## Parameters

<table><thead><tr><th>

Parameter

</th><th>

Type

</th><th>

Description

</th></tr></thead>
<tbody><tr><td>

value

</td><td>

number \| string \| boolean \| object \| null

</td><td>

_(Optional)_ value to parse

</td></tr>
<tr><td>

type

</td><td>

[TPinotDataType](./pinot-noir.tpinotdatatype.md)

</td><td>

_(Optional)_ value type

</td></tr>
</tbody></table>
**Returns:**

number \| string \| boolean \| object \| null \| bigint \| Date \| undefined

parsed value
Loading

0 comments on commit 1c102ca

Please sign in to comment.