type2docfx/out/FileStorage.yml

A tool to convert json format output from TypeDoc to universal reference model for DocFx to consume.

### YamlMime:UniversalReference
items:
  - uid: botbuilder.FileStorage
    name: FileStorage
    fullName: FileStorage
    children:
      - botbuilder.FileStorage.delete
      - botbuilder.FileStorage.constructor
      - botbuilder.FileStorage.nextTag
      - botbuilder.FileStorage.read
      - botbuilder.FileStorage.write
    langs:
      - typeScript
    type: class
    summary: >-
      A file based storage provider. Items will be persisted to a folder on
      disk.
    package: botbuilder
    remarks: >-
      The following example shows how to construct a configured instance of the
      provider:


      ```JavaScript

      const { FileStorage } = require('botbuilder');

      const path = require('path');


      const storage = new FileStorage(path.join(__dirname, './state'));

      ```
  - uid: botbuilder.FileStorage.delete
    name: delete
    children: []
    type: method
    langs:
      - typeScript
    summary: ''
    syntax:
      content: 'function delete(keys: string[])'
      parameters:
        - id: keys
          type:
            - 'string[]'
          description: ''
      return:
        type:
          - Promise<void>
  - uid: botbuilder.FileStorage.constructor
    name: FileStorage
    children: []
    type: constructor
    langs:
      - typeScript
    summary: Creates a new FileStorage instance.
    syntax:
      content: 'new FileStorage(path: string)'
      parameters:
        - id: path
          type:
            - string
          description: |
            Root filesystem path for where the provider should store its items.
  - uid: botbuilder.FileStorage.nextTag
    name: nextTag
    fullName: nextTag
    children: []
    langs:
      - typeScript
    type: property
    summary: ''
    syntax:
      content: 'static nextTag: number = 0'
      return:
        type:
          - number
  - uid: botbuilder.FileStorage.read
    name: read
    children: []
    type: method
    langs:
      - typeScript
    summary: ''
    syntax:
      content: 'function read(keys: string[])'
      parameters:
        - id: keys
          type:
            - 'string[]'
          description: ''
      return:
        type:
          - Promise<StoreItems>
  - uid: botbuilder.FileStorage.write
    name: write
    children: []
    type: method
    langs:
      - typeScript
    summary: ''
    syntax:
      content: 'function write(changes: StoreItems)'
      parameters:
        - id: changes
          type:
            - StoreItems
          description: ''
      return:
        type:
          - Promise<void>
references:
  - uid: botbuilder.ConsoleAdapter
    spec.typeScript:
      - name: ConsoleAdapter
        fullName: ConsoleAdapter
        uid: botbuilder.ConsoleAdapter