Skip to content

docs: add typescript examples #5605

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.

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 3 commits into
base: main
Choose a base branch
from

Conversation

SergeyKazarinov
Copy link
Contributor

@SergeyKazarinov SergeyKazarinov commented May 4, 2025


name: Pull Request
about: Create a pull request to improve this repository
title: "Add TypeScript Examples"
labels: "docs"
assignees: "Sergey Kazarinov"

Description

Problem

In some examples it is not obvious how to use TypeScript, which causes difficulties. Also, when using the library with TypeScript earlier, an error was found (already fixed) due to the lack of examples

Changes

In this PR I migrated the docs-site to TypeScript and added all existing examples with typing.
As an addition, I added tabs to switch the display of code from JS to TS

Screenshots

image
image

To reviewers

Contribution checklist

  • I have followed the contributing guidelines.
  • I have added sufficient test coverage for my changes.
  • I have formatted my code with Prettier and checked for linting issues with ESLint for code readability.

Copy link

codecov bot commented May 4, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 96.98%. Comparing base (3f115e0) to head (d128864).

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #5605      +/-   ##
==========================================
- Coverage   97.01%   96.98%   -0.03%     
==========================================
  Files          30       30              
  Lines        3355     3355              
  Branches     1416     1416              
==========================================
- Hits         3255     3254       -1     
+ Misses        100       99       -1     
- Partials        0        2       +2     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant