simple-optional 1.0.0 → 1.0.1

package/README.md

@@ -0,0 +1,59 @@
+# Simple Optional
+
+A lightweight TypeScript implementation of an Optional container (inspired by Java's Optional). Encapsulates a value that may be present or absent, and provides helpers for safe access and transformations.
+
+## Features
+- Create present, nullable, or empty optionals
+- Check presence with `isPresent()` / `isEmpty()`
+- Safe retrieval with `get()`, `orElse()`, and `orElseThrow()`
+- Transform values with `map()`
+- Conditional execution with `ifPresent()`
+
+## Usage
+
+Import or include the class in your project, then:
+
+- Create an Optional with a non-null value:
+```typescript
+const o = Optional.of(42);
+```
+
+- Create an Optional that may be null:
+```typescript
+const maybe = Optional.ofNullable<number>(null);
+```
+
+- Create an empty Optional:
+```typescript
+const empty = Optional.empty<number>();
+```
+
+- Check presence:
+```typescript
+if (o.isPresent()) { /* ... */ }
+if (empty.isEmpty()) { /* ... */ }
+```
+
+- Execute when present:
+```typescript
+o.ifPresent(v => console.log(v));
+```
+
+- Transform a value:
+```typescript
+const str = Optional.of(5).map(n => 'Number ' + n); // Optional<string>
+```
+
+- Retrieve value with default or throw:
+```typescript
+const x = maybe.orElse(10);
+const y = maybe.orElseThrow(() => new Error('Missing value'));
+```
+
+## Error handling
+Errors are thrown as `Error` instances with class-prefixed messages, e.g. `[Optional] No value present`.
+
+## Notes & assumptions
+- `of()` and `set()` treat both `null` and `undefined` as invalid.
+- `ofNullable()` intentionally allows `null` to represent emptiness.
+- The class uses a private constructor—use static factories to create instances.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "simple-optional",
-	"version": "1.0.0",
+	"version": "1.0.1",
 	"description": "Simplified Optional container inspired by Java 8 implementation.",
 	"main": "index.js",
 	"types": "index.d.ts",
@@ -28,12 +28,13 @@
 	],
 	"repository": {
 		"type": "git",
-		"url": "https://gitlab.com/projetos-publicos1/rest-api-express-server.git"
+		"url": "https://gitlab.com/projetos-publicos1/simple-optional.git"
 	},
 	"keywords": [
-		"rest",
-		"api",
-		"express",
-		"http server"
+		"optional",
+		"null",
+		"undefined",
+		"utility",
+		"java.util"
 	]
 }