Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • YaDisk

Index

Constructors

  • new YaDisk(token: string): YaDisk

Accessors

  • get token(): string
  • set token(token: string): void

Methods

  • createDir(path: string): Promise<ILink>
  • isDirExist(path: string): Promise<boolean>
  • Хелпер вызывающий YaDisk.isItemExist с аргументом "type" равному "dir"

    example
    await disk.isDirExist('mydir');
    

    Parameters

    • path: string

    Returns Promise<boolean>

  • isFileExist(path: string): Promise<boolean>
  • Хелпер вызывающий YaDisk.isItemExist с аргументом "type" равному "file"

    example
    await disk.isFileExist('myfile.txt');
    

    Parameters

    • path: string

    Returns Promise<boolean>

  • проверить была ли выброшенная ошибка инстансом HttpError

    example
    try {
    await disk.getMetadata();
    } catch(e) {
    if(disk.isHttpError(e)) {
    // тип сужен до HttpError
    if(e.code === 404) {
    // ...
    }
    }
    }

    Parameters

    • e: any

      ошибка

    Returns e is HttpError

  • Проверить существует ли ресурс(файл либо папка) по указанному пути

    example
    await disk.isItemExist({ path: 'dir-or-file' });
    // true если файл или папка по указанному пути существует
    example
    await disk.isItemExist({ path: 'myfile.txt', type: 'file' });
    // true если ресурс существует и является файлом
    example
    await disk.isItemExist({ path: 'mydir', type: 'dir' });
    // true если ресурс существует и является папкой

    Parameters

    Returns Promise<boolean>

  • хелпер комбинирующий YaDisk.getUploadUrl и YaDisk.uploadByUploadUrl. Получает ссылку на загрузку и загружает по ней файл

    example
    await disk.upload({
    path: "ya-disk-file.txt",
    file: "./file.txt",
    overwrite: true,
    })
    example
    await disk.upload({
    path: "ya-disk-file.txt",
    file: fs.createReadStream("./file.txt"),
    })
    example
    await disk.upload({
    path: "ya-disk-file.txt",
    file: Buffer.from('hello world', 'utf-8'),
    })

    Parameters

    Returns Promise<void>

  • загрузить файл по полученной из getUploadUrl ссылке https://yandex.ru/dev/disk/api/reference/upload.html#response-upload

    example
    await disk.uploadByUploadUrl({
    file: "./file.txt",
    url: "url-from-get-upload-url-method"
    })
    example
    await disk.uploadByUploadUrl({
    file: fs.createReadStream("./file.txt"),
    url: "url-from-get-upload-url-method"
    })
    example
    await disk.uploadByUploadUrl({
    file: Buffer.from('hello world', 'utf-8'),
    url: "url-from-get-upload-url-method"
    })

    Parameters

    Returns Promise<void>

Generated using TypeDoc