Skip to content

Append types for xpath.parse method #139

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Append types for xpath.parse method #139

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 40 additions & 0 deletions xpath.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -49,3 +49,43 @@ export function isComment(value: SelectedValue): value is Comment;
export function isDocumentNode(value: SelectedValue): value is Document;
export function isDocumentTypeNode(value: SelectedValue): value is DocumentType;
export function isDocumentFragment(value: SelectedValue): value is DocumentFragment;

export function parse(expression: string): XPathEvaluator;

export interface XPathEvaluator {
evaluate(options: EvaluateOptions): XPathResult;
evaluateBoolean(options: EvaluateOptions): boolean;
evaluateNumber(options: EvaluateOptions): number;
evaluateString(options: EvaluateOptions): string;
evaluateNodeSet(options: EvaluateOptions): Node[];
select(options: EvaluateOptions): SelectReturnType;
select1(options: EvaluateOptions): SelectSingleReturnType;
}

export interface XPathEvaluateOptions {
node: Node;
functions?: Record<string, XPathFunction> | XPathFunctionResolver;
allowAnyNamespaceForNoPrefix?: boolean;
isHtml?: boolean;
}

export type XPathFunctionResolver = XPathFunctionBasicResolver | {
getFunction: XPathFunctionBasicResolver
};
type XPathFunctionBasicResolver = (name: string, namespace: string | null) => XPathFunction | null;

export type XPathFunction = (context: XPathFunctionContext, ...args: XPathResult[]) => unknown;

export interface XPathFunctionContext {
contextNode: Node;
}


export interface XPathResult {
booleanValue(): boolean;
numberValue(): number;
stringValue(): string;
toArray?(): Node[];
first?(): Node | null;
size?: number;
}