Skip to content

exclude tip from TipOptions (#2459) #2462

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
cpruijsen wants to merge 1 commit into
base: main
Choose a base branch
from
+15 −1
Open

exclude tip from TipOptions (#2459) #2462

Show file tree
Hide file tree
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
2 changes: 1 addition & 1 deletion src/marks/tip.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ import type {Data, FrameAnchor, MarkOptions, RenderableMark} from "../mark.js";
import type {TextStyles} from "./text.js";

/** Options for the tip mark. */
export interface TipOptions extends MarkOptions, TextStyles {
export interface TipOptions extends Omit<MarkOptions, "tip">, TextStyles {
/**
* The horizontal position channel specifying the tip’s anchor, typically
* bound to the *x* scale.
Expand Down
14 changes: 14 additions & 0 deletions test/tip.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/* eslint-disable @typescript-eslint/ban-ts-comment */

import * as Plot from "@observablehq/plot";
import {it} from "vitest";

it("a nested tip option is not allowed", () => {
// @ts-expect-error
Plot.dot([], {x: 0, y: 0, tip: {tip: true}});
});

it("Plot.tip does not accept a tip option", () => {
// @ts-expect-error
Plot.tip([], {x: 0, y: 0, tip: true});
});