From cd31624ab46445f0100fe1bea2685e3711d89b16 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Philipp=20Ku=CC=88hn?= Date: Tue, 16 Feb 2021 18:47:37 +0100 Subject: [PATCH] remove unused page --- .../docPages/guide/working-with-typescript.md | 51 ------------------- 1 file changed, 51 deletions(-) delete mode 100644 docs/src/docPages/guide/working-with-typescript.md diff --git a/docs/src/docPages/guide/working-with-typescript.md b/docs/src/docPages/guide/working-with-typescript.md deleted file mode 100644 index 0e4a1a01..00000000 --- a/docs/src/docPages/guide/working-with-typescript.md +++ /dev/null @@ -1,51 +0,0 @@ -# Working with TypeScript - -## toc - -## Introduction -The whole tiptap is code base is written in TypeScript. If you haven’t heard of it or never used it, no worries. You don’t have to. - -TypeScript extends JavaScript by adding types (hence the name). It adds new syntax, which doesn’t exist in plain JavaScript. It’s actually removed before running in the browser, but this step – the compilation – is important to find bugs early. It checks if you passe the right types of data to functions. For a big and complex project, that’s very valuable. It means we’ll get notified of lot of bugs, before shipping code to you. - -Anyway, if you don’t use TypeScript in your project, that’s fine. You’ll still be able to use tiptap and even get a really nice autocomplete for the tiptap API (if your editor supports it, but most do). - -If you’re using TypeScript in your project and want to extend tiptap, there are two things that are good to know. - -## Options type -To extend or create default options for an extension, you’ll need to define a custom type, here is an example: - -```ts -import { Extension } from '@tiptap/core' - -export interface CustomExtensionOptions { - awesomeness: number, -} - -const CustomExtension = Extension.create({ - defaultOptions: { - awesomeness: 100, - }, -}) -``` - -## Command type -The core package also exports a `Command` type, which needs to be added to all commands that you specify in your code. Here is an example: - -```ts -import { Command, Extension } from '@tiptap/core' - -const CustomExtension = Extension.create({ - addCommands() { - return { - /** - * Comments will be added to the autocomplete. - */ - yourCommand: (): Command => ({ commands }) => { - // … - }, - } - }, -}) -``` - -That’s basically it. We’re doing all the rest automatically.