Get started
Use cases
Features
API References
Post-Processing Scripts
JavaScript I/O
input will be a global variable accessible in the JS context. The structure of input is the following:1
interface Input = {
2
text: string,
3
textbox: TextBox
4
}
Copied!
where
1
interface TextBox {
2
// TopLeft.x, TopLeft.y, TopRight.x, TopRight.y, BottomRight.x, BottomRight.y, BottomLeft.x, BottomLeft.y
3
vertices: number[],
4
orientation: "Up" | "Left" | "Right" | "Down",
5
lines: {
6
words: Word[]
7
}
8
}
9
​
10
interface Word {
11
// TopLeft.x, TopLeft.y, TopRight.x, TopRight.y, BottomRight.x, BottomRight.y, BottomLeft.x, BottomLeft.y
12
vertices: number[],
13
value: string, // text in the word
14
symbols: Symbol[]
15
}
16
​
17
interface Symbol {
18
// TopLeft.x, TopLeft.y, TopRight.x, TopRight.y, BottomRight.x, BottomRight.y, BottomLeft.x, BottomLeft.y
19
vertices: number[],
20
value: string // character in the symbol
21
}
Copied!
The script is expected to write the output to the
result value in the global scope. If not, an exception will be raised. What is assigned to resultwill be in the content field of the output response.Helper Functions
FormX's post-processing script comes with the following helper functions:
1
fuzzy_search(pattern, text, options)
Copied!
This searches through a text with user-defined pattern
Parameters:
- pattern (string): Will be used to search target text
- text (string): The target text where search will be conducted upon
- options (FuzzySearchOptions): Optional parameters
- Options for configuring the fuzzy search behaviour
- max_subs (number)Optional Maximum subsitutions between the pattern and return string
- max_insert (number) Optional Amount of character that can be skipped in the pattern
- max_delete (number) Optional Amount of character that can be skipped in the return string
- max_l_dist (number) Optional Maximum Levenshtein distance allowed between the pattern and return string
Return Value:
- matches (Match[]): Array of matches
- start (number): Start position of the match
- end (number): End position of the match
- dist (number): Levenshtein distance between the matched part and the pattern
- matched (string): matched part
1
edit_distance(string1, string2)
Copied!
Returns the distance between two strings
Parameters:
- string1 (string): First string that will be compared with the other
- string2 (string): The other string
Return Value:
- Edit distance (number)
Last modified 1yr ago
Copy link