Skip to content

Commit

Permalink
Adding deno distribution files and moving files from /dist to /
Browse files Browse the repository at this point in the history
  • Loading branch information
actions-user committed Nov 29, 2022
1 parent 6666a3a commit e7ff418
Show file tree
Hide file tree
Showing 785 changed files with 59,611 additions and 206 deletions.
4 changes: 0 additions & 4 deletions .github/FUNDING.yml

This file was deleted.

143 changes: 0 additions & 143 deletions .github/workflows/ci.yaml

This file was deleted.

48 changes: 2 additions & 46 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,46 +1,2 @@
# Logs
logs
*.log
npm-debug.log*

# Runtime data
pids
*.pid
*.seed

# Directory for instrumented libs generated by jscoverage/JSCover
lib-cov

# Coverage directory used by tools like istanbul
coverage

# nyc test coverage
.nyc_output

# Grunt intermediate storage (http://gruntjs.com/creating-plugins#storing-task-files)
.grunt

# node-waf configuration
.lock-wscript

# Compiled binary addons (http://nodejs.org/api/addons.html)
build/Release

# Dependency directories
node_modules
jspm_packages

# Optional npm cache directory
.npm

# Optional REPL history
.node_repl_history

dist/test
.vscode

.DS_Store


/dist
/deno_dist

/node_modules
21 changes: 21 additions & 0 deletions deno_dist/LICENSE
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
MIT License

Copyright (c) 2020 GitHub user u/garronej

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.
121 changes: 121 additions & 0 deletions deno_dist/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
<p align="center">
<img src="https://user-images.githubusercontent.com/6702424/76674598-91ebfc00-65b1-11ea-88df-eb43f04f3cce.png">
</p>
<p align="center">
💧<i>EventEmitter's typesafe replacement</i>💧
<br>
<br>
<a href="https://github.com/garronej/evt/actions">
<img src="https://github.com/garronej/evt/workflows/ci/badge.svg?branch=main">
</a>
<a href="https://deno.land/x/evt">
<img src="https://img.shields.io/endpoint?url=https%3A%2F%2Fdeno-visualizer.danopia.net%2Fshields%2Flatest-version%2Fx%2Fevt%2Fmod.ts">
</a>
<a href="https://www.npmjs.com/package/evt">
<img src="https://img.shields.io/npm/v/evt?logo=npm">
</a>
<a href="https://bundlephobia.com/package/evt">
<img src="https://img.shields.io/bundlephobia/minzip/evt">
</a>
<a href="https://www.npmjs.com/package/evt">
<img src="https://img.shields.io/npm/dm/evt">
</a>
<a href="https://github.com/garronej/evt/blob/main/LICENSE">
<img src="https://img.shields.io/npm/l/evt">
</a>
</p>

</p>
<p align="center">
<a href="https://www.evt.land">Home</a>
-
<a href="https://docs.evt.land">Documentation</a>
</p>

---

`'evt'` is intended to be a replacement for `'events'`.
It enables and encourages **functional programming** and makes heavy use of **typescript**'s type inference features to provide **type safety** while keeping things **concise and elegant** 🍸.

<b>Suitable for any JS runtime env (deno, node, old browsers, react-native ...)</b>
- ✅ It is both a [Deno](https://deno.land/x/evt) and an [NPM](https://www.npmjs.com/evt) module. ( Achieved with [Denoify](https://github.com/garronej/denoify) )
- ✅ No external dependencies ([`tsafe`](https://github.com/garronej/tsafe), [`run-exclusive`](https://github.com/garronej/run_exclusive) and [`minimal-polyfills`](https://github.com/garronej/minimal_polyfills) are all from the same author as EVT).
-[Makes it easy to work with events in React](https://docs.evt.land/react-hooks).

Can be imported in TypeScript projects using version TypeScript >= 3.8 (February 20th, 2020) and in any plain JS projects.

> NOTE: There is very few breaking changes from v1 to v2. [Check them out](https://docs.evt.land/v1-greater-than-v2).
# Who is using it

<p align="center">
<a href="https://connext.network">
<img src="https://user-images.githubusercontent.com/6702424/84102640-4e1e5c80-aa11-11ea-9d13-df0a65c8cdaf.png">
</a>
<a href="https://www.semasim.com">
<img src="https://user-images.githubusercontent.com/6702424/84102785-aead9980-aa11-11ea-915b-5c4a5282c44e.png">
</a>
<br>
<a href="https://thegraph.com">
<img src="https://user-images.githubusercontent.com/6702424/179356567-19e2ca0a-9797-4c82-8a45-7e1d0de896a9.png">
</a>
<a href="https://insee.fr">
<img src="https://user-images.githubusercontent.com/6702424/117936881-a9358f00-b305-11eb-84b9-e61593632bdd.png">
</a>
<a href="https://www.etalab.gouv.fr/">
<img src="https://user-images.githubusercontent.com/6702424/179345089-3aee6170-e7aa-4b38-adf1-f7d132aa7be4.png">
</a>
</p>

# Install / Import

## In Deno:
```typescript
import { Evt } from "https://deno.land/x/evt/mod.ts";
```
## Anywhere else:
```bash
$ npm install --save evt
```
```typescript
import { Evt } from "evt";
```

# Try it

<p align="center">
<img src="https://user-images.githubusercontent.com/6702424/179363007-582acf54-8f83-42ac-a062-562f8de40d14.gif">
<a href="https://stackblitz.com/edit/evt-playground-gfnidx?file=index.ts">Playground</a>
</p>

# Motivations

There are a lot of things that can't easily be done with `EventEmitter`:

* Enforcing **type safety**.
* Removing a particular listener ( if the callback is an anonymous function ).
* Adding a one-time listener for the next event that meets a condition.
* Waiting \(via a Promise\) for one thing or another to happen.
_Example: waiting at most one second for the next message, stop waiting if the socket disconnects._

Why would someone pick EVT over RxJS:

* EVT's learning curve is not as steep as RxJS's.
* Generates code that is easier to grasp for people not familiar with reactive programming.

EVT is an attempt to address all these points while trying to remain as accessible as `EventEmitter`.

</br>

<p align="center">
<a href="https://evt.land">Get Started</a>
</p>

# The sticker

<p align="center">
<img src="https://user-images.githubusercontent.com/6702424/90626180-e3607d00-e21a-11ea-9c88-82880ac9cedf.png">
</p>
<p align="center">
<a href="https://teespring.com/fr/evt-sticker">Shop</a>
</p>
9 changes: 9 additions & 0 deletions deno_dist/hooks/index.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
/*
NOTE: In theory react should be a peer dependency
instead of a dev dependency.
But given that /hook is just a plugin for using Evt
with react we don't want to require react to be
installed to install Evt.
*/
export { useEvt } from "./useEvt.ts";
export { useRerenderOnStateChange } from "./useRerenderOnStateChange.ts";
Loading

0 comments on commit e7ff418

Please sign in to comment.