[Text] Split Text with Formatting API

Pipedream makes it easy to connect APIs for Formatting and 2,400+ other apps remarkably fast.

Trigger workflow on

HTTP requests, schedules and app events

Next, do this

[Text] Split Text with the Formatting API

No credit card required

▶

Watch us build a workflow

8 min

Watch now ➜

Trusted by 1,000,000+ developers from startups to Fortune 500 companies

Developers ♥ Pipedream

Getting Started#

Create a workflow to [Text] Split Text with the Formatting API. When you configure and deploy the workflow, it will run on Pipedream's servers 24x7 for free.

Configure the [Text] Split Text action
1. Connect your Formatting account
2. Configure Input
3. Configure Separator
4. Select a Segment Index
Select a trigger to run your workflow on HTTP requests, schedules or app events
Deploy the workflow
Send a test event to validate your setup
Turn on the trigger

Integrations#

[Text] Split Text with Formatting API on New Feature from Productboard API

Productboard + Formatting

Try it

[Text] Split Text with Formatting API on New Requests (Payload Only) from HTTP / Webhook API

HTTP / Webhook + Formatting

Try it

[Text] Split Text with Formatting API on New Submission from Typeform API

Typeform + Formatting

Try it

[Text] Split Text with Formatting API on Custom Events from Zoom API

Zoom + Formatting

Try it

[Text] Split Text with Formatting API on New Submission (Instant) from Jotform API

Jotform + Formatting

Try it

Details#

This is a pre-built, source-available component from Pipedream's GitHub repo. The component is developed by Pipedream and the community, and verified and maintained by Pipedream.

To contribute an update to an existing component or create a new component, create a PR on GitHub. If you're new to Pipedream component development, you can start with quickstarts for trigger span and action development, and then review the component API reference.

[Text] Split Text on Formatting

Description:Split the text on a character or word and return one or all segments

Version:0.0.5

Key:formatting-split-text

View on GitHub

Code#

import { defineAction } from "@pipedream/types";
import buildRegExp from "../../common/text/buildRegExp.mjs";
import { INDEX_ALL_SEGMENTS, SPLIT_TEXT_OPTIONS, } from "../../common/text/splitTextOptions.mjs";
import app from "../../app/formatting.app.mjs";
export default defineAction({
    name: "[Text] Split Text",
    description: "Split the text on a character or word and return one or all segments",
    key: "formatting-split-text",
    version: "0.0.5",
    type: "action",
    props: {
        app,
        input: {
            label: "Input",
            description: "Text you would like to split",
            type: "string",
        },
        separator: {
            label: "Separator",
            description: "Character or word separator to split the text on. This can also be a string representing a [Regular Expression](https://www.w3schools.com/js/js_regexp.asp)",
            type: "string",
        },
        segmentIndex: {
            label: "Segment Index",
            type: "integer",
            description: "Segment of text to return after splitting. Choose one of the options, or use a custom positive (*nth*-match) or negative (*nth-to-last* match) integer.",
            options: SPLIT_TEXT_OPTIONS,
        },
    },
    async run({ $ }) {
        const { input, segmentIndex, } = this;
        let { separator } = this;
        if (separator.startsWith("/")) {
            const regExp = buildRegExp(separator);
            separator = input.match(regExp)?.[0];
        }
        let summary = "Separator not found - returned unmodified input";
        let result = input;
        const arrResults = input.split(separator);
        const { length } = arrResults;
        if (length > 1) {
            summary = `Successfully split text into ${length} segments`;
            switch (segmentIndex) {
                case INDEX_ALL_SEGMENTS:
                    result = arrResults;
                    break;
                // this case would not be needed if 0 was accepted as an option
                // see issue #5429
                case INDEX_ALL_SEGMENTS * -1:
                    result = arrResults[0];
                    break;
                default:
                    result =
                        arrResults[segmentIndex < 0
                            ? length + segmentIndex
                            : segmentIndex];
                    break;
            }
        }
        $.export("$summary", summary);
        return result;
    },
});

Configuration#

This component may be configured based on the props defined in the component code. Pipedream automatically prompts for input values in the UI and CLI.

Label	Prop	Type	Description
Formatting	`app`	`app`	This component uses the Formatting app.
Input	`input`	`string`	Text you would like to split
Separator	`separator`	`string`	Character or word separator to split the text on. This can also be a string representing a Regular Expression
Segment Index	`segmentIndex`	`integer`	Select a value from the drop down menu:`{ "label": "First", "value": -999 }{ "label": "Second", "value": 1 }{ "label": "Last", "value": -1 }{ "label": "Second to Last", "value": -2 }{ "label": "All", "value": 999 }`