https://github.com/jordanburke/functype
A Functional Library for TypeScript based on Scala
https://github.com/jordanburke/functype
functional-programming typescript
Last synced: 3 months ago
JSON representation
A Functional Library for TypeScript based on Scala
- Host: GitHub
- URL: https://github.com/jordanburke/functype
- Owner: jordanburke
- Created: 2016-04-24T11:02:13.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2025-01-15T22:36:01.000Z (9 months ago)
- Last Synced: 2025-01-24T09:33:49.826Z (9 months ago)
- Topics: functional-programming, typescript
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/functype
- Size: 1.09 MB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Functype
[](https://github.com/jordanburke/functype/actions/workflows/pnpm-build.yml)
## A Functional Programming Library for TypeScript
Functype is a lightweight functional programming library for TypeScript, drawing inspiration from functional programming paradigms, the Scala Standard Library, and ZIO. It provides a comprehensive set of utilities and abstractions designed to facilitate functional programming within TypeScript applications.
[API Documentation](https://jordanburke.github.io/functype/)
## Core Principles
- **Immutability**: All data structures are immutable, promoting predictable and side-effect-free code
- **Type Safety**: Leverages TypeScript's type system to ensure compile-time safety
- **Composability**: Provides abstractions for building complex programs from simple components
- **Functional Paradigms**: Embraces concepts like monads, functors, and type classes
## Key Features
- **Option Type**: Handle nullable values with `Some` and `None` types
- **Either Type**: Express computation results with potential failures using `Left` and `Right`
- **List, Set, Map**: Immutable collection types with functional operators
- **Try Type**: Safely execute operations that might throw exceptions
- **Task**: Handle synchronous and asynchronous operations with error handling
- **Tuple**: Type-safe fixed-length arrays
- **Typeable**: Runtime type identification with compile-time safety
## Installation
```bash
# NPM
npm install functype
# Yarn
yarn add functype
# PNPM
pnpm add functype
# Bun
bun add functype
```
## Usage Examples
### Option
```typescript
import { Option, Some, None } from "functype"
// Create options
const value = Option("hello") // Some("hello")
const empty = Option(null) // None
const explicit = Some(42) // Some(42)
// Transform values
const length = value.map((s) => s.length) // Some(5)
const nothing = empty.map((s) => s.length) // None
// Handle default values
const result = value.getOrElse("world") // "hello"
const fallback = empty.getOrElse("world") // "world"
// Conditionally filter
const filtered = value.filter((s) => s.length > 10) // None
```
### Either
```typescript
import { Either, Right, Left } from "functype"
// Success case
const success = Right(42)
// Error case
const failure = Left("error")
// Transform values (map only applies to Right)
const doubled = success.map((x) => x * 2) // Right(84)
const stillError = failure.map((x) => x * 2) // Left("error")
// Handle errors
const value = success.getOrElse(0) // 42
const fallback = failure.getOrElse(0) // 0
// Pattern matching with fold
const result = success.fold(
(err) => `Error: ${err}`,
(val) => `Success: ${val}`,
) // "Success: 42"
```
### List
```typescript
import { List } from "functype"
const numbers = List([1, 2, 3, 4])
// Transform
const doubled = numbers.map((x) => x * 2) // List([2, 4, 6, 8])
// Filter
const evens = numbers.filter((x) => x % 2 === 0) // List([2, 4])
// Reduce
const sum = numbers.foldLeft(0)((acc, x) => acc + x) // 10
// Add/remove elements (immutably)
const withFive = numbers.add(5) // List([1, 2, 3, 4, 5])
const without3 = numbers.remove(3) // List([1, 2, 4])
```
### Try
```typescript
import { Try } from "functype"
// Safely execute code that might throw
const result = Try(() => {
// Potentially throwing operation
return JSON.parse('{"name": "John"}')
})
// Handle success/failure
if (result.isSuccess()) {
console.log("Result:", result.get())
} else {
console.error("Error:", result.error)
}
// Transform with map (only applies on Success)
const name = result.map((obj) => obj.name)
// Convert to Either
const either = result.toEither()
```
### Task
```typescript
import { Task } from "functype"
// Synchronous operations with error handling
const syncResult = Task().Sync(
() => "success",
(error) => new Error(`Failed: ${error}`),
)
// Asynchronous operations
const asyncTask = async () => {
const result = await Task().Async(
async () => await fetchData(),
async (error) => new Error(`Fetch failed: ${error}`),
)
return result
}
```
## Type Safety
Functype leverages TypeScript's advanced type system to provide compile-time safety for functional patterns, ensuring that your code is both robust and maintainable.
```typescript
// Type inference works seamlessly
const option = Option(42)
// Inferred as number
const mappedValue = option.map((x) => x.toString())
// Inferred as string
```
## Contributing
Contributions are welcome! Please feel free to submit a Pull Request.
## License
MIT License
Copyright (c) 2025 Jordan Burke
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.