microsoft-graph 2.27.0 → 2.29.0

package/docs/api/models/DataSource.md

@@ -1,161 +0,0 @@
-[Microsoft Graph SDK](../README.md) / models/DataSource
-
-# models/DataSource
-
-## Type Aliases
-
-### DataSource\<T\>
-
-> **DataSource**\<`T`\> = `object` & `AsyncIterable`\<[`Item`](#item)\<`T`\>\>
-
-Defined in: src/models/DataSource.ts:6
-
-#### Type declaration
-
-##### bodyOffset
-
-> **bodyOffset**: [`RowOffset`](../Row.md#rowoffset)
-
-##### bodyRef
-
-> **bodyRef**: [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref)
-
-##### coding
-
-> **coding**: `object`
-
-###### coding.decode
-
-> **decode**: [`RowDecoder`](#rowdecoder)\<`T`\>
-
-###### coding.encode
-
-> **encode**: [`RowEncoder`](#rowencoder)\<`T`\> \| `null`
-
-##### head
-
-> **head**: [`ColumnName`](../Column.md#columnname)[]
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` *extends* [`RecordBase`](#recordbase) |
-
-***
-
-### DataSourceRow
-
-> **DataSourceRow** = [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<[`ColumnName`](../Column.md#columnname), [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Cell`](../Cell.md#cell)\>\>
-
-Defined in: src/models/DataSource.ts:30
-
-***
-
-### Item\<T\>
-
-> **Item**\<`T`\> = `object`
-
-Defined in: src/models/DataSource.ts:23
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` *extends* [`RecordBase`](#recordbase) |
-
-#### Properties
-
-| Property | Type | Defined in |
-| ------ | ------ | ------ |
-| <a id="index"></a> `index` | [`ItemIndex`](#itemindex-1) | src/models/DataSource.ts:24 |
-| <a id="record"></a> `record` | `T` | src/models/DataSource.ts:26 |
-| <a id="rownumber"></a> `rowNumber` | [`RowNumber`](../Row.md#rownumber) | src/models/DataSource.ts:25 |
-
-***
-
-### ItemIndex
-
-> **ItemIndex** = `number` & `object`
-
-Defined in: src/models/DataSource.ts:19
-
-#### Type declaration
-
-##### \_\_brand
-
-> **\_\_brand**: `"ItemIndex"`
-
-***
-
-### RangeOperationCallback()
-
-> **RangeOperationCallback** = (`rangeRef`) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-Defined in: src/models/DataSource.ts:31
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `rangeRef` | [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref) |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-***
-
-### RecordBase
-
-> **RecordBase** = [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`CellValue`](../Cell.md#cellvalue-1)\>
-
-Defined in: src/models/DataSource.ts:29
-
-***
-
-### RowDecoder()\<T\>
-
-> **RowDecoder**\<`T`\> = (`row`) => `T`
-
-Defined in: src/models/DataSource.ts:16
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` *extends* [`RecordBase`](#recordbase) |
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `row` | [`DataSourceRow`](#datasourcerow) |
-
-#### Returns
-
-`T`
-
-***
-
-### RowEncoder()\<T\>
-
-> **RowEncoder**\<`T`\> = (`record`) => [`DataSourceRow`](#datasourcerow)
-
-Defined in: src/models/DataSource.ts:17
-
-#### Type Parameters
-
-| Type Parameter |
-| ------ |
-| `T` *extends* [`RecordBase`](#recordbase) |
-
-#### Parameters
-
-| Parameter | Type |
-| ------ | ------ |
-| `record` | `T` |
-
-#### Returns
-
-[`DataSourceRow`](#datasourcerow)

package/docs/api/services/dataSource.md

@@ -1,200 +0,0 @@
-[Microsoft Graph SDK](../README.md) / services/dataSource
-
-# services/dataSource
-
-## Functions
-
-### createItem()
-
-> **createItem**\<`T`\>(`source`, `record`, `after`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Item`](../models/DataSource.md#item)\<`T`\>\>
-
-Defined in: src/services/dataSource.ts:100
-
-Creates a new item in the data source.
-
-#### Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
-
-#### Parameters
-
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `source` | [`DataSource`](../models/DataSource.md#datasource)\<`T`\> | `undefined` | Data source to insert into. Must be initialized. |
-| `record` | `T` | `undefined` | Record to insert. |
-| `after` | `null` \| [`ItemIndex`](../models/DataSource.md#itemindex-1) | `null` | Index after which to insert the new item. If null, inserts at the end. If -1 inserts at top. |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Item`](../models/DataSource.md#item)\<`T`\>\>
-
-Newly created item, including its index, row number, and record.
-
-#### Throws
-
-If the data source is not initialized.
-
-#### Throws
-
-If the 'after' index is out of range.
-
-***
-
-### dataSourceFromRange()
-
-> **dataSourceFromRange**\<`T`\>(`rangeRef`, `decode`, `encode`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`DataSource`](../models/DataSource.md#datasource)\<`T`\>\>
-
-Defined in: src/services/dataSource.ts:38
-
-Defines a data source from a given range.
-
-#### Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
-
-#### Parameters
-
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `rangeRef` | [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref) | `undefined` | Workbook range reference to define the data source on. |
-| `decode` | [`RowDecoder`](../models/DataSource.md#rowdecoder)\<`T`\> | `undefined` | Function to decode a row into a record. |
-| `encode` | `null` \| [`RowEncoder`](../models/DataSource.md#rowencoder)\<`T`\> | `null` | Function to encode a record into a row. Optional. |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`DataSource`](../models/DataSource.md#datasource)\<`T`\>\>
-
-The initialized data source.
-
-***
-
-### dataSourceFromWorksheet()
-
-> **dataSourceFromWorksheet**\<`T`\>(`worksheetRef`, `decode`, `encode`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`DataSource`](../models/DataSource.md#datasource)\<`T`\>\>
-
-Defined in: src/services/dataSource.ts:26
-
-Define a datasource from an entire worksheet.
-
-#### Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
-
-#### Parameters
-
-| Parameter | Type | Default value | Description |
-| ------ | ------ | ------ | ------ |
-| `worksheetRef` | [`WorkbookRangeRef`](../WorkbookRange-1.md#workbookrangeref) | `undefined` | Workbook range reference to define the data source on. |
-| `decode` | [`RowDecoder`](../models/DataSource.md#rowdecoder)\<`T`\> | `undefined` | Function to decode a row into a record. |
-| `encode` | `null` \| [`RowEncoder`](../models/DataSource.md#rowencoder)\<`T`\> | `null` | Function to encode a record into a row. Optional. |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`DataSource`](../models/DataSource.md#datasource)\<`T`\>\>
-
-The initialized data source.
-
-***
-
-### deleteItem()
-
-> **deleteItem**\<`T`\>(`source`, `index`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-Defined in: src/services/dataSource.ts:145
-
-Deletes an item from the data source at the specified index.
-
-#### Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `source` | [`DataSource`](../models/DataSource.md#datasource)\<`T`\> | Data source to delete from. Must be initialized. |
-| `index` | [`ItemIndex`](../models/DataSource.md#itemindex-1) | Index of the item to delete. |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-#### Throws
-
-If the data source is not initialized.
-
-***
-
-### ~~listItems()~~
-
-> **listItems**\<`T`\>(`source`): `AsyncIterable`\<[`Item`](../models/DataSource.md#item)\<`T`\>\>
-
-Defined in: src/services/dataSource.ts:84
-
-Reads all items from the data source.
-
-#### Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `source` | [`DataSource`](../models/DataSource.md#datasource)\<`T`\> | Data source to read from. |
-
-#### Returns
-
-`AsyncIterable`\<[`Item`](../models/DataSource.md#item)\<`T`\>\>
-
-Array of all items in the data source.
-
-#### Deprecated
-
-Iterate on the source directly using `for await (const item of source)`.
-
-***
-
-### updateItem()
-
-> **updateItem**\<`T`\>(`source`, `index`, `record`): [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-Defined in: src/services/dataSource.ts:127
-
-Updates an item in the data source at the specified index.
-
-#### Type Parameters
-
-| Type Parameter | Description |
-| ------ | ------ |
-| `T` *extends* [`RecordBase`](../models/DataSource.md#recordbase) | Type of the record, extending RecordBase. |
-
-#### Parameters
-
-| Parameter | Type | Description |
-| ------ | ------ | ------ |
-| `source` | [`DataSource`](../models/DataSource.md#datasource)\<`T`\> | Data source to update. Must be initialized. |
-| `index` | [`ItemIndex`](../models/DataSource.md#itemindex-1) | Index of the item to update. |
-| `record` | `T` | New record to write at the specified index. |
-
-#### Returns
-
-[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
-
-#### Throws
-
-If the data source is not initialized.
-
-#### Throws
-
-If the index is out of range.