aboutsummaryrefslogtreecommitdiff
path: root/core/api.ts
blob: 0720c8b2bca3e4126dec6c037bc5fc9bc008b2a7 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
import { InputSentenceProps, ParseResult } from "../language/types.ts";
import { DeepPartial } from "../util/types.ts";

/**
 * @summary Core interface
 *
 * This interface gets implemented by all Core clients, so clients can be
 * swapped easily. You should probably not directly use any Core, but use the
 * abstracted API from ../api/
 */
export default abstract class Core {
	/** @summary resolved when ready */
	abstract ready: Promise<void>;

	/** @summary parse sentence */
	abstract parseSentence(input: string, options?: DeepPartial<InputSentenceProps>): Promise<ParseResult>;
};