Class EncoderBackedStore<K, V, SerializedType>

Class that provides a layer of abstraction over the base storage, allowing for the encoding and decoding of keys and values. It extends the BaseStore class.

Type Parameters

K
V
SerializedType = any

Hierarchy

BaseStore<K, V>
- EncoderBackedStore

Index

Constructors

constructor

new EncoderBackedStore<K, V, SerializedType>(fields): EncoderBackedStore<K, V, SerializedType>
Type Parameters
- K
- V
- SerializedType = any
Parameters
- fields: {
      keyEncoder: ((key) => string);
      store: BaseStore<string, SerializedType>;
      valueDeserializer: ((value) => V);
      valueSerializer: ((value) => SerializedType);
  }
  - keyEncoder: ((key) => string)
    - (key): string
      
      Parameters
      
      key: K
      
      Returns string
  - store: BaseStore<string, SerializedType>
  - valueDeserializer: ((value) => V)
    - (value): V
      
      Parameters
      
      value: SerializedType
      
      Returns V
  - valueSerializer: ((value) => SerializedType)
    - (value): SerializedType
      
      Parameters
      
      value: V
      
      Returns SerializedType
Returns EncoderBackedStore<K, V, SerializedType>
Overrides BaseStore.constructor
- Defined in langchain/src/storage/encoder_backed.ts:24

Properties

keyEncoder

keyEncoder: ((key) => string)

Type declaration

- (key): string
- Parameters
  - key: K
  Returns string

lc_kwargs

lc_kwargs: SerializedFields

lc_namespace

lc_namespace: string[] = ...

A path to the module that contains the class, eg. ["langchain", "llms"] Usually should be the same as the entrypoint the class is exported from.

lc_serializable

lc_serializable: boolean = false

store

store: BaseStore<string, SerializedType>

valueDeserializer

valueDeserializer: ((value) => V)

Type declaration

- (value): V
- Parameters
  - value: SerializedType
  Returns V

valueSerializer

valueSerializer: ((value) => SerializedType)

Type declaration

- (value): SerializedType
- Parameters
  - value: V
  Returns SerializedType

Accessors

lc_aliases

get lc_aliases(): undefined | {
[key: string]: string;
}
A map of aliases for constructor args. Keys are the attribute names, e.g. "foo". Values are the alias that will replace the key in serialization. This is used to eg. make argument names match Python.

Returns undefined | {
[key: string]: string;
}
Inherited from BaseStore.lc_aliases
- Defined in langchain/src/load/serializable.ts:132

lc_attributes

get lc_attributes(): undefined | SerializedFields
A map of additional attributes to merge with constructor args. Keys are the attribute names, e.g. "foo". Values are the attribute values, which will be serialized. These attributes need to be accepted by the constructor as arguments.

Returns undefined | SerializedFields
Inherited from BaseStore.lc_attributes
- Defined in langchain/src/load/serializable.ts:122

lc_id

get lc_id(): string[]
The final serialized identifier for the module.

Returns string[]
Inherited from BaseStore.lc_id
- Defined in langchain/src/load/serializable.ts:100

lc_secrets

get lc_secrets(): undefined | {
[key: string]: string;
}
A map of secrets, which will be omitted from serialization. Keys are paths to the secret in constructor args, e.g. "foo.bar.baz". Values are the secret ids, which will be used when deserializing.

Returns undefined | {
[key: string]: string;
}
Inherited from BaseStore.lc_secrets
- Defined in langchain/src/load/serializable.ts:112

Methods

mdelete

mdelete(keys): Promise<void>
Method to delete multiple keys at once. It works with the encoded keys.
Parameters
- keys: K[]
  
  Array of keys to delete
Returns Promise<void>
Promise that resolves when the operation is complete
Overrides BaseStore.mdelete
- Defined in langchain/src/storage/encoder_backed.ts:72

mget

mget(keys): Promise<(undefined | V)[]>
Method to get multiple keys at once. It works with the encoded keys and serialized values.
Parameters
- keys: K[]
  
  Array of keys to get
Returns Promise<(undefined | V)[]>
Promise that resolves with an array of values or undefined for each key
Overrides BaseStore.mget
- Defined in langchain/src/storage/encoder_backed.ts:43

mset

mset(keyValuePairs): Promise<void>
Method to set multiple keys at once. It works with the encoded keys and serialized values.
Parameters
- keyValuePairs: [K, V][]
  
  Array of key-value pairs to set
Returns Promise<void>
Promise that resolves when the operation is complete
Overrides BaseStore.mset
- Defined in langchain/src/storage/encoder_backed.ts:60

toJSON

toJSON(): Serialized
Returns Serialized
Inherited from BaseStore.toJSON
- Defined in langchain/src/load/serializable.ts:140

toJSONNotImplemented

toJSONNotImplemented(): SerializedNotImplemented
Returns SerializedNotImplemented
Inherited from BaseStore.toJSONNotImplemented
- Defined in langchain/src/load/serializable.ts:214

yieldKeys

yieldKeys(prefix?): AsyncGenerator<string | K, any, unknown>
Method to yield keys. It works with the encoded keys.
Parameters
- Optional prefix: string
  
  Optional prefix to filter keys
Returns AsyncGenerator<string | K, any, unknown>
AsyncGenerator that yields keys
Overrides BaseStore.yieldKeys
- Defined in langchain/src/storage/encoder_backed.ts:82

`Static` lc_name

lc_name(): string
The name of the serializable. Override to provide an alias or to preserve the serialized module name in minified environments.

Implemented as a static method to support loading logic.

Returns string
Inherited from BaseStore.lc_name
- Defined in langchain/src/load/serializable.ts:93

Class EncoderBackedStore<K, V, SerializedType>

Type Parameters

K

V

SerializedType = any

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

K

V

SerializedType = any

Parameters

fields: { keyEncoder: ((key) => string); store: BaseStore<string, SerializedType>; valueDeserializer: ((value) => V); valueSerializer: ((value) => SerializedType); }

keyEncoder: ((key) => string)

Parameters

key: K

Returns string

store: BaseStore<string, SerializedType>

valueDeserializer: ((value) => V)

Parameters

value: SerializedType

Returns V

valueSerializer: ((value) => SerializedType)

Parameters

value: V

Returns SerializedType

Returns EncoderBackedStore<K, V, SerializedType>

Properties

keyEncoder

Type declaration

Parameters

key: K

Returns string

lc_kwargs

lc_namespace

lc_serializable

store

valueDeserializer

Type declaration

Parameters

value: SerializedType

Returns V

valueSerializer

Type declaration

Parameters

value: V

Returns SerializedType

Accessors

lc_aliases

Returns undefined | { [key: string]: string; }

lc_attributes

Returns undefined | SerializedFields

lc_id

Returns string[]

lc_secrets

Returns undefined | { [key: string]: string; }

Methods

mdelete

Parameters

keys: K[]

Returns Promise<void>

mget

Parameters

keys: K[]

Returns Promise<(undefined | V)[]>

mset

Parameters

keyValuePairs: [K, V][]

Returns Promise<void>

toJSON

Returns Serialized

toJSONNotImplemented

Returns SerializedNotImplemented

yieldKeys

fields: {
keyEncoder: ((key) => string);
store: BaseStore<string, SerializedType>;
valueDeserializer: ((value) => V);
valueSerializer: ((value) => SerializedType);
}

Returns undefined | {
[key: string]: string;
}

Returns undefined | {
[key: string]: string;
}

`Optional` prefix: string

`Static` lc_name