rename createProfiler to createRenderStream

Author: phryneas

src/index.ts

@@ -4,7 +4,7 @@ export type {
   RenderStreamWithRenderFn,
 } from "./profile/profile.js";
 export {
-  createProfiler,
+  createRenderStream,
   useTrackRenders,
   WaitForRenderTimeoutError,
 } from "./profile/profile.js";

src/profile/Render.tsx

@@ -13,7 +13,6 @@ import { within, screen } from "@testing-library/dom";
 import { JSDOM, VirtualConsole } from "jsdom";
 import { applyStackTrace, captureStackTrace } from "./traces.js";
 
-/** @internal */
 export interface BaseRender {
   id: string;
   phase: "mount" | "update" | "nested-update";
@@ -28,7 +27,7 @@ export interface BaseRender {
 }
 
 type Screen = typeof screen;
-/** @internal */
+
 export type SyncScreen = {
   [K in keyof Screen]: K extends `find${string}`
     ? {
@@ -38,7 +37,6 @@ export type SyncScreen = {
     : Screen[K];
 };
 
-/** @internal */
 export interface Render<Snapshot> extends BaseRender {
   /**
    * The snapshot, as returned by the `takeSnapshot` option of `profile`.
@@ -66,7 +64,6 @@ export interface Render<Snapshot> extends BaseRender {
   renderedComponents: Array<string | React.ComponentType>;
 }
 
-/** @internal */
 export class RenderInstance<Snapshot> implements Render<Snapshot> {
   id: string;
   phase: "mount" | "update" | "nested-update";
@@ -138,7 +135,7 @@ export class RenderInstance<Snapshot> implements Render<Snapshot> {
     return () => snapScreen;
   }
 }
-/** @internal */
+
 export function errorOnDomInteraction() {
   const events: Array<keyof DocumentEventMap> = [
     "auxclick",

src/profile/profile.tsx

@@ -15,7 +15,7 @@ export type ValidSnapshot =
 
 /** only used for passing around data internally */
 const _stackTrace = Symbol();
-/** @internal */
+
 export interface NextRenderOptions {
   timeout?: number;
   [_stackTrace]?: string;
@@ -104,8 +104,7 @@ export type ProfilerOptions<Snapshot extends ValidSnapshot> = {
   skipNonTrackingRenders?: boolean;
 };
 
-/** @internal */
-export function createProfiler<Snapshot extends ValidSnapshot = void>({
+export function createRenderStream<Snapshot extends ValidSnapshot = void>({
   onRender,
   snapshotDOM = false,
   initialSnapshot,
@@ -349,7 +348,6 @@ export function createProfiler<Snapshot extends ValidSnapshot = void>({
   return Profiler;
 }
 
-/** @internal */
 export class WaitForRenderTimeoutError extends Error {
   constructor() {
     super("Exceeded timeout waiting for next render.");

src/renderHookToSnapshotStream.ts

@@ -1,15 +1,13 @@
 import { RenderHookOptions } from "@testing-library/react";
 import {
-  createProfiler,
+  createRenderStream,
   NextRenderOptions,
-  ProfiledComponentFields,
   ValidSnapshot,
 } from "./profile/profile.js";
 import { Render } from "./profile/Render.js";
 import { createElement } from "react";
 import { Assertable, assertableSymbol, markAssertable } from "./assertable.js";
 
-/** @internal */
 export interface ProfiledHook<Snapshot extends ValidSnapshot>
   extends Assertable {
   /**
@@ -62,7 +60,7 @@ export function renderHookToSnapshotStream<
   renderCallback: (props: Props) => ReturnValue,
   { initialProps, ...options }: RenderHookOptions<Props> = {}
 ): HookSnapshotStream<Props, ReturnValue> {
-  const { render, ...stream } = createProfiler<ReturnValue>();
+  const { render, ...stream } = createRenderStream<ReturnValue>();
 
   const ProfiledHook: React.FC<Props> = (props) => {
     stream.replaceSnapshot(renderCallback(props));

src/renderToRenderStream.ts

@@ -3,7 +3,7 @@ import {
   type RenderResult as BaseResult,
 } from "@testing-library/react";
 import {
-  createProfiler,
+  createRenderStream,
   ProfiledComponentFields,
   ProfiledComponentOnlyFields,
   ProfilerOptions,
@@ -33,7 +33,7 @@ export function renderToRenderStream<Snapshot extends ValidSnapshot = void>(
     ...options
   }: RenderOptions<Snapshot> = {}
 ): RenderResult<Snapshot> {
-  const { render, ...stream } = createProfiler<Snapshot>({
+  const { render, ...stream } = createRenderStream<Snapshot>({
     onRender,
     snapshotDOM,
     initialSnapshot,