Function create

Returns ((props, parameters?) => Readonly<{
    accessors: {
        [Key in string | number | symbol]: Readonly<{
            find: (() => Promise<HTMLElement>);
            findAll: (() => Promise<HTMLElement[]>);
            get: (() => HTMLElement);
            getAll: (() => HTMLElement[]);
            query: (() => null | HTMLElement);
            queryAll: (() => HTMLElement[]);
        }>
    };
    fireEvent: ((eventKey, options?) => void);
    qs: RenderResult;
    run: (<Key>(scenarioKey, ...args) => Promise<void>);
    wrappers: {
        [Key in string | number | symbol]: ReturnType<Wrappers[Key]>[1]
    };
}>)

• • (props, parameters?): Readonly<{
        accessors: {
            [Key in string | number | symbol]: Readonly<{
                find: (() => Promise<HTMLElement>);
                findAll: (() => Promise<HTMLElement[]>);
                get: (() => HTMLElement);
                getAll: (() => HTMLElement[]);
                query: (() => null | HTMLElement);
                queryAll: (() => HTMLElement[]);
            }>
        };
        fireEvent: ((eventKey, options?) => void);
        qs: RenderResult;
        run: (<Key>(scenarioKey, ...args) => Promise<void>);
        wrappers: {
            [Key in string | number | symbol]: ReturnType<Wrappers[Key]>[1]
        };
    }>

  • function that renders components and initializes accessors, events, wrappers etc.

    Parameters

    • props: Partial<Props>

      props of target component

    • parameters: {
          wrapperParams?: Partial<{
              [Key in string | number | symbol]: Parameters<Wrappers[Key]>[1]
          }>;
      } = {}

      parameters of wrappers

      • Optional wrapperParams?: Partial<{
            [Key in string | number | symbol]: Parameters<Wrappers[Key]>[1]
        }>

    Returns Readonly<{
        accessors: {
            [Key in string | number | symbol]: Readonly<{
                find: (() => Promise<HTMLElement>);
                findAll: (() => Promise<HTMLElement[]>);
                get: (() => HTMLElement);
                getAll: (() => HTMLElement[]);
                query: (() => null | HTMLElement);
                queryAll: (() => HTMLElement[]);
            }>
        };
        fireEvent: ((eventKey, options?) => void);
        qs: RenderResult;
        run: (<Key>(scenarioKey, ...args) => Promise<void>);
        wrappers: {
            [Key in string | number | symbol]: ReturnType<Wrappers[Key]>[1]
        };
    }>

    engine for integration testing