Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lopatnov/namespace
Dynamic namespace creation
https://github.com/lopatnov/namespace
namespace typescript
Last synced: 2 months ago
JSON representation
Dynamic namespace creation
- Host: GitHub
- URL: https://github.com/lopatnov/namespace
- Owner: lopatnov
- License: apache-2.0
- Created: 2020-08-10T00:34:46.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-04T22:47:11.000Z (5 months ago)
- Last Synced: 2024-10-05T02:05:06.449Z (3 months ago)
- Topics: namespace, typescript
- Language: TypeScript
- Homepage:
- Size: 621 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
# @lopatnov/namespace
[](https://www.npmjs.com/package/@lopatnov/namespace)
[](https://www.npmjs.com/package/@lopatnov/namespace)
[](https://github.com/lopatnov/namespace/blob/master/LICENSE)
[](https://github.com/lopatnov/namespace/issues)
[](https://github.com/lopatnov/namespace/network)
[](https://github.com/lopatnov/namespace/stargazers)
[](https://www.npmjs.com/package/@lopatnov/namespace?activeTab=dependencies)
[](https://www.linkedin.com/in/lopatnov/)
Dynamic namespace creation
## Install
As NPM package
```shell
npm install @lopatnov/namespace
```
As browser script
```html
```
## Import package to the project
### ESM import
```typescript
import Namespace from "@lopatnov/namespace";
```
### CJS require
```javascript
var Namespace = require("@lopatnov/namespace");
```
## TypeScript and JavaScript samples
### namespace creation
```ts
const ns = new Namespace(); // <-- create namespace variable
ns.namespace("a.b.c.d"); // <-- create inner namespaces
ns.namespace("a.b.c.e"); // <-- Function namespace(path: NamespacePath): Namespace
ns.namespace("a.b.f.g"); // <--
ns.namespace("a.i.h.k"); // <--
ns.namespace("a.i.h.l"); // <--
ns.namespace("a.m.n.o"); // <--
// Access to inner namespaces
const anyNS: any = ns; // <-- to avoid type casting
console.log(anyNS.a.b.f.g instanceof Namespace); // true
console.log((ns as any).a.b.c.d instanceof Namespace); // true
console.log((ns as any).a.b.c.e instanceof Namespace); // true
```
### attach namespace to a current object
```ts
let shapes = {
color: "green",
count: 3
};
let shapesSpace = Namespace.attach(shapes); // <-- Namespace.attach(to: T) => T & Namespace
shapesSpace.namespace('Triangles');
shapesSpace.namespace('Circles');
shapesSpace.namespace('Rectangles.Squares');
console.log(shapesSpace.exists('Triangles')); // true
console.log(shapesSpace.exists('Circles')); // true
console.log(shapesSpace.exists('Rectangles.Squares')); // true
console.log(shapesSpace.color); // "green"
console.log(shapesSpace.count); // 3
console.log(shapes === shapesSpace); // true
```
#### checking that object inside namespace exists
```ts
// Function exists(path: NamespacePath): boolean
console.log(ns.exists('a.b.c.d')); // true
console.log(ns.exists('a.b.c.e')); // true
console.log(ns.exists('a.b.f.g')); // true
console.log(ns.exists('a.i.h.k')); // true
console.log(ns.exists('a.i.h.l')); // true
console.log(ns.exists('a.m.n.o')); // true
```
### create namespace through direct call
```ts
var dynamicNamespace: any = Namespace; // <-- escape current TypeScript restrictions with any Type
var a = dynamicNamespace('Pacific.Ocean'); // <-- call as function
console.log(a.Pacific.Ocean instanceof Namespace); // true
```
### create namespace through new operator
```ts
var n: any = new Namespace("Hello.World");
console.log(n.Hello.World instanceof Namespace); // true
```
```ts
var eeny: any = new Namespace('meeny.miny.moe[Catch][a][tiger][by][the][toe]');
console.log(eeny.meeny.miny.moe.Catch.a.tiger.by.the.toe instanceof Namespace); // true
```
### go to inner object
```ts
var kitchenRadar = new Namespace();
kitchenRadar.namespace('big.fruits');
kitchenRadar.namespace('big.eggs');
kitchenRadar.namespace('small.dishes');
kitchenRadar.namespace('small.cookies');
var fruits = kitchenRadar.goto('big.fruits'); // <-- goto(path: NamespacePath): any
var eggs = kitchenRadar.goto('big.eggs');
var dishes = kitchenRadar.goto('small.dishes');
var cookies = kitchenRadar.goto('small.cookies');
console.log(fruits === (kitchenRadar as any).big.fruits); // true
console.log(eggs === (kitchenRadar as any).big.eggs); // true
console.log(dishes === (kitchenRadar as any).small.dishes); // true
console.log(cookies === (kitchenRadar as any).small.cookies); // true
```
### apply namespace as a property of an object
```ts
var persons: any = {};
var extension = new Namespace('with.small.kitty');
extension.applyTo(persons, 'Julia'); // Function applyTo(context: any, name: string): void
extension.applyTo(persons, 'Kathy');
extension.applyTo(persons, 'Liza');
console.log(persons.Julia.with.small.kitty instanceof Namespace); // true
console.log(persons.Kathy.with.small.kitty instanceof Namespace); // true
console.log(persons.Liza.with.small.kitty instanceof Namespace); // true
```
## Demo
See, how it's working: [https://runkit.com/lopatnov/namespace](https://runkit.com/lopatnov/namespace)
Test it with a runkit: [https://npm.runkit.com/@lopatnov/namespace](https://npm.runkit.com/%40lopatnov%2Fnamespace)
## Rights and Agreements
License [Apache-2.0](https://github.com/lopatnov/namespace/blob/master/LICENSE)
Copyright 2020–2021 Oleksandr Lopatnov