npmpackage.info

Gathering detailed insights and metrics for optics-ts

Other packages similar to optics-ts

monocle-ts

2.3.13

A porting of scala monocle library to TypeScript

@optics-xyz/ts-interface

1.1.0

Optics contract typechain gens

ts-optics

1.1.0

Tired of updating nested JS objects? Not convinced that optional chaining isn't a filthy hack? This one's for you.

spectacles-ts

1.0.7

Practical Optics • Unfancy monocle-ts 🧐

Gathering detailed insights and metrics for optics-ts

optics-ts - 2.4.1 | npmpackage.info

optics-ts

Type-safe, ergonomic, polymorphic optics for TypeScript

2.4.1

874

MIT

TypeScript

133.86 kB

4.8

Installations

npm install optics-ts

Developer Guide

BETA

Typescript

No

Module System

CommonJS, ESM

Pull Requests

Open

9

Total

396

Closed

42

Merged

345

Issues

Open

12

Total

31

Closed

19

Releases

v2.4.1

Updated on Jul 10, 2023

v2.4.0

Updated on Nov 03, 2022

v2.3.0

Updated on Dec 23, 2021

v2.2.2

Updated on Oct 22, 2021

v2.2.0

Updated on Sep 07, 2021

v2.1.0

Updated on Mar 27, 2021

View All 6 releases

Languages

TypeScript

JavaScript

Shell

TypeScript (99.38%)

JavaScript (0.55%)

Shell (0.07%)

Developer

akheron

Download Statistics

Total Downloads

Last Day

Last Week

Last Month

Last Year

GitHub Statistics

MIT License

874 Stars

486 Commits

13 Forks

11 Watchers

8 Branches

7 Contributors

Updated on Jul 14, 2025

Maintainers

View All 7 Contributors

Package Meta Information

Latest Version

2.4.1

Package Id

optics-ts@2.4.1

Unpacked Size

133.86 kB

Size

22.72 kB

File Count

121

Published on

Jul 10, 2023

Total Downloads

Cumulative downloads

Total Downloads

NaN

Last Day

NaN

Compared to previous day

Last Week

NaN

Compared to previous week

Last Month

NaN

Compared to previous month

Last Year

NaN

Compared to previous year

Weekly Downloads

Monthly Downloads

Yearly Downloads

Dev Dependencies

@babel/types @types/jest @typescript-eslint/eslint-plugin @typescript-eslint/parser eslint eslint-config-prettier eslint-plugin-prettier jest prettier ts-jest typescript

optics-ts

optics-ts provides type-safe, ergonomic, polymorphic optics for TypeScript:

Optics allow you to read or modify values from deeply nested data structures, while keeping all data immutable.
Ergonomic: Optics are composed with method chaining, making it easy and fun!
Polymorphic: When writing through the optics, you can change the data types in the nested structure.
Type-safe: The compiler will type check all operations you do. No any, ever.

➡ Documentation ⬅

Features

optics-ts supports lenses, prisms, traversals, removing items from containers, and much more!

Since optics-ts v2.2.0, there are two syntaxes for defining optics: method chaining (the default) and standalone optics (experimental). See the docs for more info!

Getting started

Installation:

npm install optics-ts

yarn add optics-ts

Here's a simple example demonstrating how lenses can be used to drill into a nested data structure:

1import * as O from 'optics-ts'
2
3type Book = {
4  title: string
5  isbn: string
6  author: {
7    name: string
8  }
9}
10
11// Create a lens that focuses on author.name
12const optic = O.optic_<Book>().prop('author').prop('name')
13
14// This is the input data
15const input: Book = {
16  title: "The Hitchhiker's Guide to the Galaxy",
17  isbn: '978-0345391803',
18  author: {
19    name: 'Douglas Adams',
20  },
21}
22
23// Read through the optic
24O.get(optic)(input)
25// "Douglas Adams"
26
27// Write through the optic
28O.set(optic)('Arthur Dent')(input)
29// {
30//   title: "The Hitchhiker’s Guide to the Galaxy"
31//   isbn: "978-0345391803",
32//   author: {
33//     name: "Arthur Dent"
34//   }
35// }
36
37// Update the existing value through the optic, while also changing the data type
38O.modify(optic)((str) => str.length + 29)(input)
39// {
40//   title: "The Hitchhiker’s Guide to the Galaxy"
41//   isbn: "978-0345391803",
42//   author: {
43//     name: 42
44//   }
45// }

Another example that converts all words longer than 5 characters to upper case:

1import * as O from 'optics-ts/standalone'
2
3const optic = O.optic<string>().words().when(s => s.length >= 5)
4
5const input = 'This is a string with some shorter and some longer words'
6O.modify(optic)((s) => s.toUpperCase()(input)
7// "This is a STRING with some SHORTER and some LONGER WORDS"

See the documentation for a tutorial and a detailed reference of all supported optics.

Development

Run yarn to install dependencies.

Running the test suite

Run yarn test.

For compiling and running the tests when files change, run these commands in separate terminals:

yarn build:test --watch
yarn jest dist-test/ --watchAll

Documentation

You need Python 3 to build the docs.

python3 -m venv venv
./venv/bin/pip install mkdocs-material

Run a live reloading server for the documentation:

./venv/bin/mkdocs serve

Open http://localhost:8000/ in the browser.

Releasing

$ yarn version --new-version <major|minor|patch>
$ yarn publish
$ git push origin main --tags

Open https://github.com/akheron/optics-ts/releases, edit the draft release, select the newest version tag, adjust the description as needed.

No vulnerabilities found.

10

Code-Review

Determines if the project requires human code review before pull requests (aka merge requests) are merged.

10

Dangerous-Workflow

Determines if the project's GitHub Action workflows avoid dangerous patterns.

10

Binary-Artifacts

Determines if the project has generated executable (binary) artifacts in the source repository.

10

License

Determines if the project has defined a license.

8

Vulnerabilities

Determines if the project has open, known unfixed vulnerabilities.

2

SAST

Determines if the project uses static code analysis.

0

Maintained

Determines if the project is "actively maintained".

0

Token-Permissions

Determines if the project's workflows follow the principle of least privilege.

0

Pinned-Dependencies

Determines if the project has declared and pinned the dependencies of its build process.

0

CII-Best-Practices

Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.

0

Security-Policy

Determines if the project has published a security policy.

0

Fuzzing

Determines if the project uses fuzzing.

Score

4.8

/10

Last Scanned on 2025-07-07

The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.

Learn More