Skip to content

Commit

Permalink
random bool transformer docs
Browse files Browse the repository at this point in the history
  • Loading branch information
evisdrenova committed Nov 13, 2023
1 parent 0bbacdf commit 80e9660
Show file tree
Hide file tree
Showing 3 changed files with 48 additions and 1 deletion.
40 changes: 40 additions & 0 deletions docs/docs/transformers/system/random-bool.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
title: Random Boolean
id: random-bool
hide_title: true
slug: /transformers/system/random-bool
---

import { TransformerPageHeader } from '@site/src/CustomComponents/TransformerPageHeader.tsx';

import { DocsTable } from '@site/src/CustomComponents/DocsTable.tsx';

<TransformerPageHeader
title="Random Boolean"
type="bool"
apiRef="https://github.com/nucleuscloud/neosync/blob/main/worker/internal/benthos/transformers/random_bool.go"
/>

## Definition

The random boolean transformer randomly generates a boolean value.

## Configurations

There are no configurations for the random boolean transformer.

## Examples

Here are some examples of what an output random boolean value may look like.

<DocsTable
headers={['Example Input', 'Example Output']}
rowData={[
{
data: ['false', 'true'],
},
{
data: ['true', 'false'],
},
]}
/>
5 changes: 5 additions & 0 deletions docs/sidebars.js
Original file line number Diff line number Diff line change
Expand Up @@ -176,6 +176,11 @@ const sidebars = {
id: 'transformers/system/ssn',
label: 'SSN',
},
{
type: 'doc',
id: 'transformers/system/random-bool',
label: 'Random Boolean',
},
],
},
{
Expand Down
4 changes: 3 additions & 1 deletion docs/src/theme/DocSidebarItem/Link/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ import { GrMysql } from 'react-icons/gr';
import { IoBuildOutline } from 'react-icons/io5';
import { MdPassword } from 'react-icons/md';
import { PiArrowsSplitLight, PiFlaskLight } from 'react-icons/pi';
import { RxAvatar } from 'react-icons/rx';
import { RxAvatar, RxComponentBoolean } from 'react-icons/rx';
import { SiKubernetes } from 'react-icons/si';
import styles from './styles.module.css';

Expand Down Expand Up @@ -140,6 +140,8 @@ export const RenderIcon = (name) => {
return <FaRegAddressBook />;
case 'Gender':
return <BsGenderAmbiguous />;
case 'Random Boolean':
return <RxComponentBoolean />;
default:
return <LayersIcon />;
}
Expand Down

0 comments on commit 80e9660

Please sign in to comment.