@obsidize/rx-socket

Index

Namespaces

JsonBufferMapUtility

Classes

Interfaces

Type aliases

Type aliases

BufferUntilPredicate

BufferUntilPredicate<T>: (value: T, state: BufferUntilState<T>) => boolean

Type parameters

T

Type declaration

- (value: T, state: BufferUntilState<T>): boolean
- Parameters
  - value: T
  - state: BufferUntilState<T>
  Returns boolean

SendAction

SendAction<T>: (value: T) => Observable<any>

Type parameters

T

Type declaration

- (value: T): Observable<any>
- Parameters
  - value: T
  Returns Observable<any>

Functions

allSubjectsDestroyed

allSubjectsDestroyed(subjects: Subject<any>[]): boolean

- Defined in core/utility.ts:44
Parameters
- subjects: Subject<any>[]
Returns boolean

Const bufferUntil

bufferUntil<T>(predicate: BufferUntilPredicate<T>, flushOnComplete?: boolean): OperatorFunction<T, T[]>

- Defined in core/buffer-until.ts:40
Buffers input until the given predicate returns true for a given buffer state and value. Emits all buffered values up until (and including) the value for which the predicate returns a truthy value.

Type parameters
- T
Parameters
- predicate: BufferUntilPredicate<T>
- Optional flushOnComplete: boolean
Returns OperatorFunction<T, T[]>

Const bufferUntilTerminator

bufferUntilTerminator(options?: JsonBufferMapOptions): OperatorFunction<string, string[]>

- Defined in core/operators.ts:33
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<string, string[]>

Const bufferUntilTerminatorExclusive

bufferUntilTerminatorExclusive(options?: JsonBufferMapOptions): OperatorFunction<string, string[]>

- Defined in core/operators.ts:43
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<string, string[]>

destroyAllSubjects

destroyAllSubjects(subjects: Subject<any>[], errorMessage?: string): void

- Defined in core/utility.ts:36
Parameters
- subjects: Subject<any>[]
- Optional errorMessage: string
Returns void

destroySubject

destroySubject(subject: Subject<any>, errorMessage?: string): void

- Defined in core/utility.ts:31
Parameters
- subject: Subject<any>
- errorMessage: string = 'destroyed'
Returns void

identity

identity<T>(value: T, ..._args: any[]): any

- Defined in core/utility.ts:3
Type parameters
- T
Parameters
- value: T
- Rest ..._args: any[]
Returns any

isErrorable

isErrorable(value: any): boolean

- Defined in core/utility.ts:27
Parameters
- value: any
Returns boolean

isFunction

isFunction(value: any): boolean

- Defined in core/utility.ts:7
Parameters
- value: any
Returns boolean

isPopulatedString

isPopulatedString(value: any): boolean

- Defined in core/utility.ts:48
Parameters
- value: any
Returns boolean

isString

isString(value: any): boolean

- Defined in core/utility.ts:11
Parameters
- value: any
Returns boolean

isSubjectDestroyed

isSubjectDestroyed(subject: Subject<any>): boolean

- Defined in core/utility.ts:40
Parameters
- subject: Subject<any>
Returns boolean

isSubscribable

isSubscribable(value: any): boolean

- Defined in core/utility.ts:19
Parameters
- value: any
Returns boolean

isUnsubscribable

isUnsubscribable(value: any): boolean

- Defined in core/utility.ts:23
Parameters
- value: any
Returns boolean

Const mapBufferToJson

mapBufferToJson<T>(options?: JsonBufferMapOptions): OperatorFunction<Uint8Array, T>

- Defined in core/operators.ts:67
Type parameters
- T
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<Uint8Array, T>

Const mapBufferToString

mapBufferToString(options?: JsonBufferMapOptions): OperatorFunction<Uint8Array, string>

- Defined in core/operators.ts:27
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<Uint8Array, string>

Const mapJsonToBuffer

mapJsonToBuffer<T>(options?: JsonBufferMapOptions): OperatorFunction<T, Uint8Array>

- Defined in core/operators.ts:20
Type parameters
- T
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<T, Uint8Array>

Const mapJsonToString

mapJsonToString<T>(options?: JsonBufferMapOptions): OperatorFunction<T, string>

- Defined in core/operators.ts:8
Type parameters
- T
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<T, string>

Const mapStringToBuffer

mapStringToBuffer(options?: JsonBufferMapOptions): OperatorFunction<string, Uint8Array>

- Defined in core/operators.ts:14
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<string, Uint8Array>

Const mapStringToJson

mapStringToJson<T>(options?: JsonBufferMapOptions): OperatorFunction<string, T>

- Defined in core/operators.ts:53
Type parameters
- T
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<string, T>

Const mapStringToTerminatedJson

mapStringToTerminatedJson<T>(options?: JsonBufferMapOptions): OperatorFunction<string, T>

- Defined in core/operators.ts:59
Type parameters
- T
Parameters
- options: JsonBufferMapOptions = ...
Returns OperatorFunction<string, T>

Const mutateBufferUntilState

mutateBufferUntilState<T>(predicate: BufferUntilPredicate<T>, state: BufferUntilState<T>, value: T): BufferUntilState<T>

- Defined in core/buffer-until.ts:17
Modifies the state based on the return value of the predicate. If the predicate returns true for the given state and value, payload will be set to the state's buffer plus the given value.

Type parameters
- T
Parameters
- predicate: BufferUntilPredicate<T>
- state: BufferUntilState<T>
- value: T
Returns BufferUntilState<T>

splitInclusive

splitInclusive(value: string, separator: string): string[]

- Defined in core/utility.ts:52
Parameters
- value: string
- separator: string
Returns string[]

toString

toString(value: any): string

- Defined in core/utility.ts:15
Parameters
- value: any
Returns string

Generated using TypeDoc