@types/jscodeshift/src/collections/JSXElement.d.ts

TypeScript definitions for jscodeshift

import astTypes = require("ast-types");
import nodePath = require("ast-types/lib/node-path");
import Collection = require("../Collection");

type ASTPath<N> = nodePath.NodePath<N, N>;
type JSXElement = astTypes.namedTypes.JSXElement;

export interface GlobalMethods {
    /**
     * Finds all JSXElements optionally filtered by name
     */
    findJSXElements(name?: string): Collection.Collection<JSXElement>;

    /**
     * Finds all JSXElements by module name. Given
     *
     *     var Bar = require('Foo');
     *     <Bar />
     *
     * findJSXElementsByModuleName('Foo') will find <Bar />, without having to
     * know the variable name.
     */
    findJSXElementsByModuleName(moduleName: string): Collection.Collection<JSXElement>;
}

type Defined<T> = T extends undefined ? never : T;
type JSXElementChild = Defined<JSXElement["children"]>[0];

export interface TraversalMethods {
    /**
     * Returns all child nodes, including literals and expressions.
     * This method only applies to JSXElement typed collections.
     */
    childNodes(): Collection.Collection<JSXElementChild>;

    /**
     * Returns all children that are JSXElements.
     * This method only applies to JSXElement typed collections.
     */
    childElements(): Collection.Collection<JSXElement>;
}

interface Filter {
    (path: ASTPath<any>): boolean;
}

export interface FilterMethods {
    /**
     * Filter method for attributes.
     */
    hasAttributes(attributeFilter: { [attributeName: string]: any }): Filter;

    /**
     * Filter elements which contain a specific child type
     */
    hasChildren(name: string): Filter;
}

export interface MappingMethods {
    /**
     * Given a JSXElement, returns its "root" name. E.g. it would return "Foo" for
     * both <Foo /> and <Foo.Bar />.
     */
    getRootName(path: ASTPath<any>): string;
}

export function register(): void;
export const filters: FilterMethods;
export const mappings: MappingMethods;

export {}; // shut off automatic exporting