@flowio/types

This module provides TypeScript type definitions for custom types found in Flow API.

Installation

npm install @flowio/types

Usage

In TypeScript:

import { apiTypes, apiInternalTypes } from '@flowio/types';
import React from 'react';

interface Props {
  order: apiTypes.Order;
  prompts: apiInternalTypes.OptinPrompt[];
}

class OrderSummary extends React.Component<Props> {
  ...
}

In JSDoc:

import React from 'react';

/**
 * @typedef {import('@flowio/types/dist/api').Order} Order
 * @typedef {import('@flowio/types/dist/api-internal').OptinPrompt} OptinPrompt
 */

/**
 * @typedef {object} Props
 * @property {Order} order
 * @property {OptinPrompt[]} prompts
 */

/**
 * @augments React.Component<Props>
 */
class OrderSummary extends React.Component {
  ...
}

License

MIT