@isdk/kvsqlite
Version:
[](https://www.npmjs.com/package/@isdk/kvsqlite) [](https://opensource.org/licenses/MIT)
300 lines (150 loc) • 6.34 kB
Markdown
[**/kvsqlite**](../README.md)
***
[/kvsqlite](../globals.md) / KVSqliteAttachments
# Class: KVSqliteAttachments
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2149](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2149)
## Constructors
### Constructor
> **new KVSqliteAttachments**(`name`, `db`): `KVSqliteAttachments`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2164](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2164)
#### Parameters
##### name
`string`
##### db
[`KVSqlite`](KVSqlite.md)
#### Returns
`KVSqliteAttachments`
## Properties
### db
> `protected` **db**: [`KVSqlite`](KVSqlite.md)
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2164](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2164)
***
### name
> **name**: `string`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2164](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2164)
***
### preAdd
> **preAdd**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2150](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2150)
***
### preAll
> **preAll**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2160](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2160)
***
### preAllLimit
> **preAllLimit**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2161](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2161)
***
### preCalcSize
> **preCalcSize**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2162](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2162)
***
### preCount
> **preCount**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2156](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2156)
***
### preCountW
> **preCountW**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2157](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2157)
***
### preDel
> **preDel**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2154](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2154)
***
### preDelAll
> **preDelAll**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2155](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2155)
***
### preExists
> **preExists**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2152](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2152)
***
### preGet
> **preGet**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2153](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2153)
***
### preSearchKey
> **preSearchKey**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2158](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2158)
***
### preSearchKeyAll
> **preSearchKeyAll**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2159](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2159)
***
### preUpdate
> **preUpdate**: `Statement`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2151](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2151)
## Methods
### add()
> **add**(`docId`, `filename`, `content`, `options`): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2211](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2211)
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename
`string`
##### content
`Buffer`
##### options
###### isText?
`boolean`
###### mime?
`string`
#### Returns
[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)
***
### del()
> **del**(`docId`, `filename?`): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md) \| [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2254](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2254)
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename?
`string` | `string`[]
#### Returns
[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md) \| [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)[]
***
### get()
> **get**(`docId`, `filename`): `object`
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2202](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2202)
Get file content
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename
`string`
#### Returns
`object`
##### content
> **content**: `Buffer`
##### filename
> **filename**: `string`
***
### list()
> **list**(`docId`, `filename`): `unknown`[]
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2207](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2207)
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename
`string` = `''`
#### Returns
`unknown`[]
***
### update()
> **update**(`docId`, `filename`, `content`, `options`): [`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)
Defined in: [packages/kvsqlite/src/kvsqlite.ts:2228](https://github.com/isdk/kvsqlite.js/blob/1628213306b4beb3b53ae08829d1de32063503c9/src/kvsqlite.ts#L2228)
#### Parameters
##### docId
[`IKVDocumentId`](../type-aliases/IKVDocumentId.md)
##### filename
`string`
##### content
`Buffer`
##### options
###### isText?
`boolean`
###### mime?
`string`
#### Returns
[`KVSqliteRunResult`](../interfaces/KVSqliteRunResult.md)