Lawtext core references / core/src/lawtext

core/src/lawtext

Interfaces

Variables

intypeChoices

const intypeChoices: readonly ["fromext", "lawtext", "xml", "json"]

Defined in: core/src/lawtext.ts:18 (opens in a new tab)

outtypeChoices

const outtypeChoices: readonly ["fromext", "lawtext", "xml", "json", "html", "htmlfragment", "docx"]

Defined in: core/src/lawtext.ts:19 (opens in a new tab)

runHelp

const runHelp: "usage: lawtext.run(<options>)\n\nexample: lawtext.run({ input: {elaws:"405AC0000000088"}, outtypes: ["lawtext"] }).then(r => console.log(r.lawtext))\n\noptions:\n input: { elaws: string } | { lawtext: string } | { xml: string } | { json: string }\n # For `elaws` input, specify lawID or lawNum to be requested to e-LAWS API.\n outtypes: ("lawtext" | "xml" | "json" | "html" | "htmlfragment" | "docx")[]\n # Specify the output types.\n figpdf: "srcText" | "embed" | "render" | "embedAndRender" [default: "embed"]\n # (Only applicable for the combination of `elaws` input and `docx` output.)\n # Specify how to process embedded PDF files.\n analyze: boolean [default: false]\n # If true, conduct the analysis process.\n format: boolean [default: false]\n # If true, format the XML or JSON output.\n controlel: boolean [default: false]\n # If true, emit the control elements in XML or JSON output.\n"

Defined in: core/src/lawtext.ts:30 (opens in a new tab)

Functions

run()

run(args): Promise<Partial<RunResult>>

Defined in: core/src/lawtext.ts:62 (opens in a new tab)

Parameters

args

RunArgs

Returns

Promise<Partial<RunResult>>

Tocsupplprovision Runargs