NDEx JavaScript Client API Reference - v0.6.0-alpha.5
    Preparing search index...

    Interface FileSearchParams

    Parameters for searching files in NDEx

    interface FileSearchParams {
        searchString?: string;
        accountName?: string;
        permission?: Permission;
        type?: null | NDExFileType;
        visibility: "PUBLIC" | "PRIVATE";
        start?: number;
        size?: number;
    }
    Index

    Properties

    searchString? accountName? permission? type? visibility start? size?

    Properties

    searchString?: string

    Search terms as a string, supports Lucene syntax

    accountName?: string

    Username of the account to filter on, only files owned by that user will be returned

    permission?: Permission

    Filter by permission level, only applicable to signed-in users

    type?: null | NDExFileType

    File type to filter on, if null or omitted all file types will be returned

    visibility: "PUBLIC" | "PRIVATE"

    Visibility filter, only supports "PRIVATE" or "PUBLIC"

    start?: number

    Starting index for pagination

    size?: number

    Number of results to return for pagination

    Settings

    Member Visibility

    On This Page

    Properties