TypeScript types

Last updated:

PostHog supports TypeScript apps natively, without you having to compile the TypeScript yourself (although you can also do that).

To build a TypeScript app, you'll probably need some types, so read on.

Installation

To use the types in your app, you can install them as follows:

Terminal
# if using yarn
yarn add --dev @posthog/plugin-scaffold


# if using npm
npm install --save-dev @posthog/plugin-scaffold

Then, in your apps, you can use them like so:

typescript
import { PluginEvent, PluginMeta } from '@posthog/plugin-scaffold'


export function processEvent(event: PluginEvent, meta: PluginMeta) {
    if (event.properties) {
        event.properties['hello'] = 'world'
    }
    return event
}

Questions?

Was this page useful?

Next article

Data warehouse (beta)

The PostHog data warehouse gives you a place to put all of your most important data, query across these datasets, and combine it with the product analytics data already in PostHog. Powered by Clickhouse, the data warehouse enables you to query across big datasets quickly. Data warehouse is currently in private beta . This means we're inviting a select number of people to try this product out. If you want to give this a go, click the "Get support" button in the top right, select "Data Warehouse…

Read next article