-
Notifications
You must be signed in to change notification settings - Fork 5
/
HNa.ts
191 lines (168 loc) · 3.57 KB
/
HNa.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
/*
* Copyright (c) 2020, J2 Innovations. All Rights Reserved
*/
/* eslint @typescript-eslint/no-unused-vars: "off", @typescript-eslint/no-empty-function: "off" */
import { Kind } from './Kind'
import {
HVal,
NOT_SUPPORTED_IN_FILTER_MSG,
valueInspect,
valueIsKind,
valueMatches,
} from './HVal'
import { HaysonNa } from './hayson'
import { Node } from '../filter/Node'
import { HGrid } from './HGrid'
import { HList } from './HList'
import { HDict } from './HDict'
import { EvalContext } from '../filter/EvalContext'
import { JsonV3Na } from './jsonv3'
/**
* An immutable JSON value.
*/
const JSON_NA = {
_kind: Kind.NA,
}
let na: HNa
/**
* Haystack NA value.
*/
export class HNa implements HVal {
/**
* Constructs a new haystack marker.
*/
private constructor() {}
/**
* Makes an na.
*
* @returns A na instance.
*/
public static make(): HNa {
return na ?? (na = Object.freeze(new HNa()) as HNa)
}
/**
* @returns The value's kind.
*/
public getKind(): Kind {
return Kind.NA
}
/**
* Compares the value's kind.
*
* @param kind The kind to compare against.
* @returns True if the kind matches.
*/
public isKind(kind: Kind): boolean {
return valueIsKind<HNa>(this, kind)
}
/**
* Returns true if the haystack filter matches the value.
*
* @param filter The filter to test.
* @param cx Optional haystack filter evaluation context.
* @returns True if the filter matches ok.
*/
public matches(filter: string | Node, cx?: Partial<EvalContext>): boolean {
return valueMatches(this, filter, cx)
}
/**
* Dump the value to the local console output.
*
* @param message An optional message to display before the value.
* @returns The value instance.
*/
public inspect(message?: string): this {
return valueInspect(this, message)
}
/**
* @returns A string representation of the value.
*/
public toString(): string {
return this.toZinc()
}
/**
* @returns The zinc encoded string.
*/
public valueOf(): string {
return this.toZinc()
}
/**
* Encodes to an encoding zinc value.
*
* @returns The encoded zinc string.
*/
public toZinc(): string {
return 'NA'
}
/**
* Encodes to an encoded zinc value that can be used
* in a haystack filter string.
*
* A dict isn't supported in filter so throw an error.
*
* @returns The encoded value that can be used in a haystack filter.
*/
public toFilter(): string {
throw new Error(NOT_SUPPORTED_IN_FILTER_MSG)
}
/**
* Value equality check.
*
* @param value The value to test.
* @returns True if the value is the same.
*/
public equals(value: unknown): boolean {
return valueIsKind<HNa>(value, Kind.NA)
}
/**
* Compares two values.
*
* @param value The value to compare against.
* @returns The sort order as negative, 0, or positive
*/
public compareTo(value: unknown): number {
return valueIsKind<HNa>(value, Kind.NA) ? 0 : -1
}
/**
* @returns A JSON reprentation of the object.
*/
public toJSON(): HaysonNa {
return JSON_NA
}
/**
* @returns A JSON v3 representation of the object.
*/
public toJSONv3(): JsonV3Na {
return 'z:'
}
/**
* @returns An Axon encoded string of the value.
*/
public toAxon(): string {
return 'na()'
}
/**
* @returns Returns the value instance.
*/
public newCopy(): HNa {
return this
}
/**
* @returns The value as a grid.
*/
public toGrid(): HGrid {
return HGrid.make(this)
}
/**
* @returns The value as a list.
*/
public toList(): HList<HNa> {
return HList.make(this)
}
/**
* @returns The value as a dict.
*/
public toDict(): HDict {
return HDict.make(this)
}
}