source: node_modules/types-ramda/README.md

main
Last change on this file was d24f17c, checked in by Aleksandar Panovski <apano77@…>, 17 months ago

Initial commit

  • Property mode set to 100644
File size: 1.4 KB
Line 
1# `types-ramda`
2
3**Requires at least `typescript@5`**
4
5## Official types library for ramda
6
7`@types/ramda` has been community driven for a long time. It is however very incomplete. The goal is this library is to improve the overall types for ramda by moving ownership in-house
8
9The end-goal is to eventually migration this repo into the core ramda repo, but for now, so we can independently update and release new typings,
10this repo will house the types, be publish to `npm` where `@types/ramda` will re-export what is here
11
12To get a sense of what migration back into the core repo will look like, check out `ts` branch that is there now.
13
14Please see the Github Issues page which is being used to define work left to do
15
16## Usage
17
18**`types-ramda` is not intended to be used directly!**
19
20`@types/ramda` should continued to be used. `@types/ramda` re-exports what is defined here. The type definitions were moved into those repo for 2 reasons
21
22* in-house control of all definitions
23* set up work such that this repo can eventually be moved into the core `ramda` repo
24
25### Note about semver
26
27We cannot lock the semver to be the same as `ramda`'s since we plan on doing multiple releases to this library to progressively update the types
28until they are all correct. We will keep up with minor releases starting at `0.29.0` up until `1.0.0`.
29
30`@types/ramda` will be updated to latest of this package after every release
Note: See TracBrowser for help on using the repository browser.