Fs / lookup

Language

Get file information from its name. Errors: - ESTALE - The parent inode does not exist. - ENOENT - The name does not exist within the directory. - ENOTDIR - The parent inode was not a directory.

Request parameters

{
    /** The model's id. */
    modelId: string,
    /** If provided, the filesystem of the snapshot will be used. Otherwise, the filesystem of the model will be used. */
    snapshotId?: string,
    /** Inode number of the parent directory. */
    parent: number,
    /** Filename within the parent directory. */
    name: string | Buffer
}

Response

{
    /** If successful. One of "result" and "error" will be present. */
    result?: {
        inode: number,
        stat: Stat
    },

    /** If failed */
    error?: {
        code: 'model_not_found' | 'snapshot_not_found' | 'ESTALE' | 'ENOENT' | 'ENOTDIR' | 'bad_credentials' | 'too_many_requests' | 'payment_required' | 'unknown'
    } | {
        code: 'invalid_parameter',
        parameterName: string,
        reason: string
    }
}

Where "Stat" is defined as:

export type Stat = {
    mode: number,
    nlink: number,
    rdev: number,
    size: number,
    blksize: number,
    blocks: number,
    atime: number,
    atime_nsec: number,
    mtime: number,
    mtime_nsec: number,
    ctime: number,
    ctime_nsec: number
}

Example

Following the installation guide to setup the Decthings API for TypeScript. Add your parameters to the following code and run it in Node.js, or in a browser by using a bundler.

The code reads your API key from file. Create an API key and save it to the file "auth.txt". Keep your key safe!

import * as fs from 'fs'
import { DecthingsClient } from '@decthings/api-client'

let apiKey = fs.readFileSync('./auth.txt').toString().trim()
let client = new DecthingsClient({ apiKey })

async function main() {
    try {
        let response = await client.fs.lookup({
            modelId: /* Add modelId here */,
            parent: /* Add parent here */,
            name: /* Add name here */
        })
        if (result.error) {
            // Decthings sent us an error
            console.log(response.error)
        } else {
            // Success!
            console.log(response.result)
        }
    }
    catch (e) {
        // Client throws an error on connection issues. The function may or may not have succeded
        console.log(e)
    }
}
main()

Product

Company

Get going!