https://github.com/tremorlabs/tinybird-utils

https://github.com/tremorlabs/tinybird-utils

Last synced: 1 day ago
JSON representation

• Host: GitHub
• URL: https://github.com/tremorlabs/tinybird-utils
• Owner: tremorlabs
• Created: 2023-04-21T16:52:12.000Z (over 1 year ago)
• Default Branch: master
• Last Pushed: 2023-05-05T13:59:49.000Z (over 1 year ago)
• Last Synced: 2024-10-12T22:44:03.401Z (about 1 month ago)
• Language: TypeScript
• Size: 59.6 KB
• Stars: 12
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
## Tremor Tinybird Plugin

```

npm i tinybird-utils

```

### API

The plugin exports a `useFetchPipe` function that provides a single interface to easily query [Tinybird pipes](https://www.tinybird.co/docs/concepts/pipes.html) using [SWR](https://swr.vercel.app/).

**Arguments:**

- `name`: The name of the Tinybird pipe.

- `queryParams` (optional): The query parameters of the pipe as a JSON-object.

- `config` (optional): The Tinybird configuration as a JSON-object.

- `responseType` (optional): The API response type. `'JSON' | 'CSV' | 'Ndjson' | 'Parquet'`

**Example:**

```jsx

// Example.tsx

import { useFetchPipe } from 'tinybird-utils';

import { LineChart } from '@tremor/react';

export default function Example() {

  const { data, status } = useFetchPipe('my_sales_data_pipe', {

    date_from: '2023-01-01',

    date_to: '2023-03-01'

  });

  return status === 'loading' ? (

    
Loading...

  ) : (

    

  );

}

```


### Configuration

Configuration parameters:

- `token`: The Tinybird auth token

- `baseUrl` (optional): The Tinybird API base url, i.e. the tinybird pipe prefix up to the pipe name. Default: `https://api.tinybird.co/v0/pipes/`

**(1) Using the `TbConfigProvider`:**

```jsx

// ContextProvider.tsx

import { TbConfigProvider } from 'tinybird-utils';

export default function ContextProvider({ children }) {

  const token = '';

  const baseUrl = 'https://ui.us-east.tinybird.co/v0/pipes/';

  return (

    

      {children}

    

  );

}

```

The config values can be set in one of the `TbConfigProvider`s child components using the `TbConfigContext` and the provided setters:

```jsx

// Example.tsx

import { TbConfigContext } from 'tinybird-utils';

import { useContext } from 'react';

...

const { setToken, setBaseUrl } = useContext(TbConfigContext);

...

```

Once the config parameters are set in the `TbConfigProvider`, the `useFetchPipe` function will automatically obtain the config from the `TbConfigContext`.

**(2) Directly providing a config via the `config` argument of the `useFetchPipe` as a JSON-object.**

```jsx

const { data } = useFetchPipe(

  'my_pipe',

  {

    date_from: '2023-01-01',

    date_to: '2023-03-01'

  },

  {

    token: '',

    // Optional

    baseUrl: 'https://api.us-east.tinybird.co/v0/pipes/'

  }

);

```