Lawtext core references / core/src/lawtext
Module: core/src/lawtext
Table of contents
Namespaces
Interfaces
Variables
Functions
Variables
intypeChoices
• Const
intypeChoices: readonly ["fromext"
, "lawtext"
, "xml"
, "json"
]
Defined in
core/src/lawtext.ts:15 (opens in a new tab)
outtypeChoices
• Const
outtypeChoices: readonly ["fromext"
, "lawtext"
, "xml"
, "json"
, "html"
, "htmlfragment"
, "docx"
]
Defined in
core/src/lawtext.ts:16 (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 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:26 (opens in a new tab)
Functions
run
▸ run(args
): Promise
<Partial
<RunResult
>>
Parameters
Name | Type |
---|---|
args | RunArgs |
Returns
Promise
<Partial
<RunResult
>>