@w-lfpup/wctk 0.1.0 → 0.2.1

package/docs/subscription.md

@@ -1,85 +0,0 @@
-# Subscribe Controller
-
-Subscribe web components to external state.
-
-## How to use
-
-### Callbacks
-
-Create functions that subscribe and unsubscribe an element from a data store.
-
-The result of the subscribe function is passed as the to the unsubscribe function.
-
-```ts
-import { Datastore } from "./some-datastore.js";
-
-let store = new Datastore();
-
-function subscribe(callback): number {
-	return store.subscribe(callback);
-}
-
-function unsubscribe(results: number): void {
-	store.unsubscribe(results);
-}
-
-export { store, subscribe, unsubscribe };
-```
-
-### Controller
-
-Add a `Subscription` controller to a web component. Pass subscribe, unsubscribe, and a callback function on instantiation.
-
-```ts
-import { Subscription } from "wctk";
-import { getState, subscribe, unsubscribe } from "./datastore.js";
-
-class MyElement extends HTMLElement {
-	#sc = new Subscription({
-		host: this,
-		callback: this.#update,
-		subscribe,
-		unsubscribe,
-	});
-
-	#update() {
-		let state = getState();
-		// do something with state
-	}
-
-	// lifecycle method
-	connectedCallback() {
-		this.#sc.connect();
-		this.#update();
-	}
-
-	// lifecycle method
-	disconnectedCallback() {
-		this.#sc.disconnect();
-	}
-}
-```
-
-### Shortcut life cycle methods
-
-In the example below, the `connected` property is set to true and the component is immediately subscribed on instantiation.
-
-```ts
-import { Subscription } from "wctk";
-import { getState, subscribe, unsubscribe } from "./datastore.js";
-
-class MyElement extends HTMLElement {
-	#sc = new Subscription({
-		host: this,
-		callback: this.#update,
-		connected: true,
-		subscribe,
-		unsubscribe,
-	});
-
-	#update() {
-		let state = getState();
-		// do something with state
-	}
-}
-```

package/src/bind.ts

@@ -1,22 +0,0 @@
-export interface BindParamsInterface {
-	host: Object;
-	callbacks: Function[];
-}
-
-export class Bind {
-	constructor(params: BindParamsInterface) {
-		let { host, callbacks } = params;
-
-		for (let callback of callbacks) {
-			// do not bind and replace already bound functions
-			if (
-				callback instanceof Function &&
-				!callback.hasOwnProperty("prototype")
-			) {
-				let { name } = callback;
-				if (!name.startsWith("#"))
-					host[name as keyof typeof host] = callback.bind(host);
-			}
-		}
-	}
-}

package/src/subscription.ts

@@ -1,47 +0,0 @@
-export type Subscribe<E, A> = (cb: E) => A;
-export type Unsubscribe<A> = (affect: A) => void;
-
-export interface SubscriptionInterface {
-	connect(): void;
-	disconnect(): void;
-}
-
-export interface SubscriptionParamsInterface<E, A> {
-	host: Object;
-	callback: E;
-	connected?: boolean;
-	subscribe: Subscribe<E, A>;
-	unsubscribe: Unsubscribe<A>;
-}
-
-export class Subscription<E, A> implements SubscriptionInterface {
-	#callback: E;
-	#affect?: A;
-	#subscribe: Subscribe<E, A>;
-	#unsubscribe: Unsubscribe<A>;
-
-	constructor(params: SubscriptionParamsInterface<E, A>) {
-		let { host, callback, connected, subscribe, unsubscribe } = params;
-
-		this.#subscribe = subscribe;
-		this.#unsubscribe = unsubscribe;
-
-		this.#callback = callback;
-		if (
-			callback instanceof Function &&
-			!callback.hasOwnProperty("prototype")
-		) {
-			this.#callback = callback.bind(host);
-		}
-
-		if (connected) this.connect();
-	}
-
-	connect() {
-		if (!this.#affect) this.#affect = this.#subscribe(this.#callback);
-	}
-
-	disconnect() {
-		if (this.#affect) this.#unsubscribe(this.#affect);
-	}
-}