callbag korean readme

readme.md

Origin

Callbag 👜

가벼운 Observable 과 Iterable을 구현할 수 있게 하는 자바스크립트의 콜백을 위한 표준

• 최소한의 오버헤드를 가지고 있는 스트림, Iterable, Observable, AsyncIterable 등
• Modular (각각의 오퍼레이터는 그 자체로 하나의 npm 패키지입니다.)
• 가벼움 (적은 메모리 할당)
• 라이브러리가 아닙니다, 그저 표준일 뿐입니다. (라이브러리를 찾고 계신다면 callbag-basics을 확인하시거나 위키를 확인해 주세요.)
• 여러분만의 유틸리티를 제작하는 것이 매우 쉽습니다. 유틸리티 제작하는 방법

그리고 이 글들도 읽어 보세요.

• callbag이 필요한 이유
• callbag 소개.

요약

• 모든 producer는 (type: number, payload?: any) => void 입니다.
• 모든 consumer는 (type: number, payload?: any) => void 입니다.
• type === 0 은 "start" 를 의미합니다. (Observable 의 "subscribe" 와 같습니다.)
• type === 1 은 "data" 를 의미합니다. (Observable 의 "next" 와 같습니다)
• type === 2 은 "end" 을 의미합니다. (Subscriptions의 "unsubscribe" 와 같습니다.)

명세

(type: number, payload?: any) => void

정의

• Callbag: (type: 0 | 1 | 2, payload?: any) => void 타입의 값.
• Greet: if a callbag is called with 0 as the first argument, we say "the callbag is greeted", while the code which performed the call "greets the callbag"
• Deliver: if a callbag is called with 1 as the first argument, we say "the callbag is delivered data", while the code which performed the call "delivers data to the callbag"
• Terminate: if a callbag is called with 2 as the first argument, we say "the callbag is terminated", while the code which performed the call "terminates the callbag"
• Source: a callbag which is expected to deliver data
• Sink: a callbag which is expected to be delivered data

Protocol

The capitalized keywords used here follow IETF's RFC 2119.

Greets: (type: 0, cb: Callbag) => void

A callbag is greeted when the first argument is 0 and the second argument is another callbag (a function).

Handshake

When a source is greeted and given a sink as payload, the sink MUST be greeted back with a callbag payload that is either the source itself or another callbag (known as the "talkback"). In other words, greets are mutual. Reciprocal greeting is called a handshake.

Termination: (type: 2, err?: any) => void

A callbag is terminated when the first argument is 2 and the second argument is either undefined (signalling termination due to success) or any truthy value (signalling termination due to failure).

After the handshake, the source MAY terminate the sink. Alternatively, the sink MAY terminate the source after the handshake has occurred. If the source terminates the sink, then the sink SHOULD NOT terminate the source, and vice-versa. In other words, termination SHOULD NOT be mutual.

Data delivery (type: 1, data: any) => void

Amount of deliveries:

• A callbag (either sink or source) MAY be delivered data, once or multiple times

Window of valid deliveries:

• A callbag MUST NOT be delivered data before it has been greeted
• A callbag MUST NOT be delivered data after it has been terminated
• A sink MUST NOT be delivered data after it terminates its source

Reserved codes

A callbag SHOULD NOT be called with any of these numbers as the first argument: 3, 4, 5, 6, 7, 8, 9. Those are called reserved codes. A callbag MAY be called with codes other than those in the range [0-9], but this specification makes no claims in those cases.

Legal

This project is offered to the Public Domain in order to allow free use by interested parties who want to create compatible implementations. For details see COPYING and CopyrightWaivers.txt.

To the extent possible under law, Callbag Standard Special Interest Group has waived all copyright and related or neighboring rights to Callbag Standard. This work is published from: Finland.