Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bensimmers/tsc-options
https://github.com/bensimmers/tsc-options
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/bensimmers/tsc-options
- Owner: BenSimmers
- Created: 2024-05-05T02:34:33.000Z (9 months ago)
- Default Branch: main
- Last Pushed: 2024-05-10T13:43:30.000Z (9 months ago)
- Last Synced: 2024-11-15T17:09:31.973Z (2 months ago)
- Language: TypeScript
- Homepage: https://www.npmjs.com/package/ts-options
- Size: 78.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
Awesome Lists containing this project
README
# Types
This document describes a set of TypeScript types used to represent the presence or absence of values, HTTP headers, and HTTP requests.
## Option Types
### `None`
Represents the absence of a value.
- **type** (`string`): The type identifier indicating the absence of a value ("none").
### `Some`
Represents the presence of a value.
- **type** (`string`): The type identifier indicating the presence of a value ("some").
- **value** (`T`): The value wrapped by Some.
### `Option`
Represents the presence or absence of a value.
- **None | Some\**: Either None or Some type.
## HTTP Types
### `Headers`
Represents HTTP headers as a key-value pair where both key and value are strings.
- **Record\**
### `Request`
Represents an HTTP request object.
- **url** (`string`): The URL of the request.
- **headers** (`Headers`): The headers of the request.
- **method** (`string`, optional): The HTTP method of the request.
- **body** (`string`, optional): The body of the request.
## Partial Types
### `PartialOption`
Represents a partial option, where all properties of the Option type are optional.
- **Partial\>**
### `PartialSome`
Represents a partial Some, where all properties of the Some type are optional.
- **Partial\>**
### `PartialNone`
Represents a partial None, where all properties of the None type are optional.
- **Partial\**
## Optional Record Types
### `OptionalRecord`
Represents an optional record where each value is of type Option\.
- **Record\>**
### `OptionalSomeRecord`
Represents an optional record where each value is of type Some\.
- **Record\>**
### `OptionalNoneRecord`
Represents an optional record where each value is of type None.
- **Record\**
### `OptionalPartialRecord`
Represents an optional record where each value is of type Partial\>.
- **Record\>>**
# Result
**export type Result = Ok | Err;**
- Represents the result of an operation that can either succeed with a value of type T or fail with an error of type E.
```typescript
const result: Result = { type: "ok", value: 42 };
```
## OK Type
- **type Ok = { type: "ok"; value: T };**
Creates an OK type that wraps the value.
```typescript
const ok: Ok = { type: "ok", value: 42 };
```
## Error Type
- **type Err = { type: "err"; error: E };**
Creates an error type that wraps the error value.
```typescript
const error: Err = { type: "err", error: "An error occurred" };
```
# Methods - Optional Utilities Documentation
## Creation Functions
### `some(value: T): Some`
Creates a Some value wrapping the provided value.
- **value** (`T`): The value to wrap in a Some.
```typescript
const someValue = some(42);
```
### `none: None`
Represents the absence of a value.
```typescript
const noneValue = none;
```
## Error Handling Functions
### `OptionalCatch(fn: Function): Option`
Executes the provided function and wraps its result in Some if successful, otherwise returns None.
- **fn** (`Function`): The function to call to get the value.
```typescript
const result = OptionalCatch(() => {
throw new Error("An error occurred");
});
```
### `optionalResolve(promise: Promise): Promise>`
Executes the provided promise and wraps its result in Some if resolved successfully, otherwise returns None.
- **promise** (`Promise`): The promise to resolve.
## Mapping and Transformation Functions
### `OptionalMap(option: Option, fn: Function): Option`
Maps the value of an Option using the provided function.
- **option** (`Option`): The Option to map.
- **fn** (`Function`): The mapping function.
```typescript
const result = OptionalMap(some(42), (value) => value * 2);
```
### `toOptional(fn: Function): Function`
Converts a function into an Optional function, returning Some if successful, otherwise returns None.
- **fn** (`Function`): The function to convert.
```typescript
const optionalFunction = toOptional(() => 42);
const result = optionalFunction(); // Some(42)
```
## Validation and Unwrapping Functions
### `optionalDefined: Function`
Checks if the argument is defined (neither null nor undefined).
- **arg** (`unknown`): The argument to check.
```typescript
const result = optionalDefined(42); // Some(42)
```
### `unwrap(option: Option): T`
Unwraps the value from the Option. Throws an error if the Option is None.
- **option** (`Option`): The Option to unwrap.
```typescript
const value = unwrap(some(42)); // 42
```
### `unwrapOr(opt: Option, fallback: T): T`
Unwraps the value from the Option or returns a fallback value if the Option is None.
- **opt** (`Option`): The Option to unwrap.
- **fallback** (`T`): The fallback value to return if the Option is None.
```typescript
const value = unwrapOr(some(42), 0); // 42
```
### `unwrapExpect(opt: Option, message: string): T`
Unwraps the value from the Option or throws an error with the provided message if the Option is None.
- **opt** (`Option`): The Option to unwrap.
- **message** (`string`): The message to include in the error if the Option is None.
```typescript
const value = unwrapExpect(some(42), "Value is None"); // 42
```
## HTTP Utilities
### `fetchWithOption(request: Request): Promise>`
Represents an HTTP request.
- **request** (`Request`): The HTTP request object.
Returns: A promise resolving to a Some value containing the response data, or None if an error occurs.
```ts
const request: Request = {
url: "https://api.example.com",
headers: { "Content-Type": "application/json" },
method: "GET",
};
const response = await fetchWithOption(request);
response.map((data) => console.log(data));
```
## Types
- **Some\**: Represents the presence of a value.
- **None**: Represents the absence of a value.
- **Option\**: Represents the presence or absence of a value.
- **Request**: Represents an HTTP request object.