Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/onify/flow-script-functions
Flow Script Functions - A set of script functions to use in Onify Flow
https://github.com/onify/flow-script-functions
nodejs onify onify-functions
Last synced: about 5 hours ago
JSON representation
Flow Script Functions - A set of script functions to use in Onify Flow
- Host: GitHub
- URL: https://github.com/onify/flow-script-functions
- Owner: onify
- License: mit
- Created: 2024-02-05T09:57:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-02T07:46:14.000Z (6 months ago)
- Last Synced: 2024-05-02T21:06:08.948Z (6 months ago)
- Topics: nodejs, onify, onify-functions
- Language: TypeScript
- Homepage: https://onify.co
- Size: 24.4 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Onify Script Functions
[](https://github.com/onify/flow-script-functions/actions/workflows/build.yaml)
This library provides various functions designed for Onify Flow that can also be used in Node.js applications.
The functions available are as follows:
- [generate UUID](#generate-uuid)
- [slugify](#slugify)
- [validate email](#validate-email)
## Onify Flow
Use `functions.*` to access the functions present in this library.
```js
const result = functions.slugify('sample onify');
console.log(result); // output: sample-onify
```
## Installation
```
npm install @onify/flow-script-functions
```
## Usage
### Import the library:
##### Javascript
```js
const functions = require('@onify/flow-script-functions');
```
##### Typescript
```ts
// import all functions
import * as functions from '@onify/flow-script-functions';
// or
// import specific functions
import { slugify } from '@onify/flow-script-functions';
```
### Use the functions:
```ts
// example usage of `slugify` function
let output = functions.slugify('Hello World!');
// or
// when using specific imports in TypeScript
output = slugify('Hello World!');
```
## Generate UUID
Creates a GUID string using `crypto`
### Syntax
```
generateUuid(): string
```
### Return value
GUID string with the format `${string}-${string}-${string}-${string}-${string}`
### Example
```ts
import { generateUuid } from '@onify/flow-script-functions';
// ...
const id = generateUuid(); // generates random GUID
console.log(id); // sample output: "55d03475-45fe-4415-81d7-8cd052081fe1"
```
## Slugify
Transforms string to kebab case
### Syntax
```
slugify(text: string): string
```
### Parameters
| Name | Type | Description |
| :--- | :------- | ----------------------------- |
| text | `string` | the string value to transform |
### Return value
`kebab-case` of the input
### Example
```ts
import { slugify } from '@onify/flow-script-functions';
// ...
const transformedText = slugify('Hello World!');
console.log(transformedText); // output: "hello-world"
```
## Validate Email
Checks if string is a valid email format
### Syntax
```
validateEmail(email: string): boolean
```
### Parameters
| Name | Type | Description |
| :---- | :------- | ------------------ |
| email | `string` | string to validate |
### Return value
`true` if input is a valid email format, otherwise `false`
### Example
```ts
import { validateEmail } from '@onify/flow-script-functions';
// ...
const isValid = slugify('[email protected]');
console.log(isValid); // output: true
```
## Release new version and publish to npm
1. Update `version` in `package.json`
2. Update `CHANGELOG.md`
3. Commit and push the changes
4. Run `npm run release`