Skip to content
This repository has been archived by the owner on Jul 16, 2024. It is now read-only.

Commit

Permalink
Version Packages (#257)
Browse files Browse the repository at this point in the history
Co-authored-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
  • Loading branch information
github-actions[bot] and github-actions[bot] authored Nov 13, 2023
1 parent 62cbddb commit 5c4165c
Show file tree
Hide file tree
Showing 13 changed files with 327 additions and 17 deletions.
6 changes: 0 additions & 6 deletions .changeset/old-books-pump.md

This file was deleted.

7 changes: 0 additions & 7 deletions .changeset/short-ants-share.md

This file was deleted.

83 changes: 83 additions & 0 deletions docs/platform-bun/Terminal.ts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Terminal.ts
nav_order: 18
parent: "@effect/platform-bun"
---

## Terminal overview

Added in v1.0.0

---

<h2 class="text-delta">Table of contents</h2>

- [constructors](#constructors)
- [make](#make)
- [layer](#layer)
- [layer](#layer-1)
- [model](#model)
- [Key](#key)
- [UserInput](#userinput)
- [tag](#tag)
- [Terminal](#terminal)

---

# constructors

## make

**Signature**

```ts
export declare const make: (shouldQuit?: ((input: UserInput) => boolean) | undefined) => Effect<Scope, never, Terminal>
```
Added in v1.0.0
# layer
## layer
**Signature**
```ts
export declare const layer: Layer<never, never, Terminal>
```
Added in v1.0.0
# model
## Key
**Signature**
```ts
export declare const Key: Key
```
Added in v1.0.0
## UserInput
**Signature**
```ts
export declare const UserInput: UserInput
```
Added in v1.0.0
# tag
## Terminal
**Signature**
```ts
export declare const Terminal: Tag<Terminal, Terminal>
```
Added in v1.0.0
83 changes: 83 additions & 0 deletions docs/platform-node/Terminal.ts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,83 @@
---
title: Terminal.ts
nav_order: 21
parent: "@effect/platform-node"
---

## Terminal overview

Added in v1.0.0

---

<h2 class="text-delta">Table of contents</h2>

- [constructors](#constructors)
- [make](#make)
- [layer](#layer)
- [layer](#layer-1)
- [model](#model)
- [Key](#key)
- [UserInput](#userinput)
- [tag](#tag)
- [Terminal](#terminal)

---

# constructors

## make

**Signature**

```ts
export declare const make: (shouldQuit?: ((input: UserInput) => boolean) | undefined) => Effect<Scope, never, Terminal>
```
Added in v1.0.0
# layer
## layer
**Signature**
```ts
export declare const layer: Layer<never, never, Terminal>
```
Added in v1.0.0
# model
## Key
**Signature**
```ts
export declare const Key: Key
```
Added in v1.0.0
## UserInput
**Signature**
```ts
export declare const UserInput: UserInput
```
Added in v1.0.0
# tag
## Terminal
**Signature**
```ts
export declare const Terminal: Tag<Terminal, Terminal>
```
Added in v1.0.0
121 changes: 121 additions & 0 deletions docs/platform/Terminal.ts.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,121 @@
---
title: Terminal.ts
nav_order: 31
parent: "@effect/platform"
---

## Terminal overview

Added in v1.0.0

---

<h2 class="text-delta">Table of contents</h2>

- [model](#model)
- [Key (interface)](#key-interface)
- [QuitException (class)](#quitexception-class)
- [UserInput (interface)](#userinput-interface)
- [models](#models)
- [Terminal (interface)](#terminal-interface)
- [tag](#tag)
- [Terminal](#terminal)

---

# model

## Key (interface)

**Signature**

```ts
export interface Key {
/**
* The name of the key being pressed.
*/
readonly name: string
/**
* If set to `true`, then the user is also holding down the `Ctrl` key.
*/
readonly ctrl: boolean
/**
* If set to `true`, then the user is also holding down the `Meta` key.
*/
readonly meta: boolean
/**
* If set to `true`, then the user is also holding down the `Shift` key.
*/
readonly shift: boolean
}
```

Added in v1.0.0

## QuitException (class)

A `QuitException` represents an exception that occurs when a user attempts to
quit out of a `Terminal` prompt for input (usually by entering `ctrl`+`c`).

**Signature**

```ts
export declare class QuitException
```

Added in v1.0.0

## UserInput (interface)

**Signature**

```ts
export interface UserInput {
/**
* The character read from the user (if any).
*/
readonly input: Option<string>
/**
* The key that the user pressed.
*/
readonly key: Key
}
```

Added in v1.0.0

# models

## Terminal (interface)

A `Terminal` represents a command-line interface which can read input from a
user and display messages to a user.

**Signature**

```ts
export interface Terminal {
/**
* Reads a single input event from the default standard input.
*/
readonly readInput: Effect<never, QuitException, UserInput>
/**
* Displays text to the the default standard output.
*/
readonly display: (text: string) => Effect<never, PlatformError, void>
}
```

Added in v1.0.0

# tag

## Terminal

**Signature**

```ts
export declare const Terminal: Tag<Terminal, Terminal>
```
Added in v1.0.0
7 changes: 7 additions & 0 deletions packages/platform-browser/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,12 @@
# @effect/platform-browser

## 0.16.2

### Patch Changes

- Updated dependencies [[`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc)]:
- @effect/platform@0.28.2

## 0.16.1

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/platform-browser/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@effect/platform-browser",
"type": "module",
"version": "0.16.1",
"version": "0.16.2",
"description": "Unified interfaces for common platform-specific services",
"publishConfig": {
"access": "public",
Expand Down
12 changes: 12 additions & 0 deletions packages/platform-bun/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,17 @@
# @effect/platform-bun

## 0.17.2

### Patch Changes

- [#256](https://github.com/Effect-TS/platform/pull/256) [`62cbddb`](https://github.com/Effect-TS/platform/commit/62cbddb530371291123dea220bfebcc0521b54df) Thanks [@jessekelly881](https://github.com/jessekelly881)! - fix: added missing File type export

- [#255](https://github.com/Effect-TS/platform/pull/255) [`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc) Thanks [@IMax153](https://github.com/IMax153)! - add basic Terminal interface for prompting user input

- Updated dependencies [[`62cbddb`](https://github.com/Effect-TS/platform/commit/62cbddb530371291123dea220bfebcc0521b54df), [`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc)]:
- @effect/platform-node@0.29.2
- @effect/platform@0.28.2

## 0.17.1

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/platform-bun/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@effect/platform-bun",
"type": "module",
"version": "0.17.1",
"version": "0.17.2",
"description": "Unified interfaces for common platform-specific services",
"publishConfig": {
"access": "public",
Expand Down
11 changes: 11 additions & 0 deletions packages/platform-node/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,16 @@
# @effect/platform-node

## 0.29.2

### Patch Changes

- [#256](https://github.com/Effect-TS/platform/pull/256) [`62cbddb`](https://github.com/Effect-TS/platform/commit/62cbddb530371291123dea220bfebcc0521b54df) Thanks [@jessekelly881](https://github.com/jessekelly881)! - fix: added missing File type export

- [#255](https://github.com/Effect-TS/platform/pull/255) [`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc) Thanks [@IMax153](https://github.com/IMax153)! - add basic Terminal interface for prompting user input

- Updated dependencies [[`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc)]:
- @effect/platform@0.28.2

## 0.29.1

### Patch Changes
Expand Down
2 changes: 1 addition & 1 deletion packages/platform-node/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@effect/platform-node",
"type": "module",
"version": "0.29.1",
"version": "0.29.2",
"description": "Unified interfaces for common platform-specific services",
"publishConfig": {
"access": "public",
Expand Down
6 changes: 6 additions & 0 deletions packages/platform/CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,11 @@
# @effect/platform

## 0.28.2

### Patch Changes

- [#255](https://github.com/Effect-TS/platform/pull/255) [`fea76da`](https://github.com/Effect-TS/platform/commit/fea76da05190a65912911bd5b6f9cc0bef3b2edc) Thanks [@IMax153](https://github.com/IMax153)! - add basic Terminal interface for prompting user input

## 0.28.1

### Patch Changes
Expand Down
Loading

0 comments on commit 5c4165c

Please sign in to comment.