Class NDExClient

NDExClient - Main client class for NDEx API operations

Provides a unified interface for all NDEx operations with intelligent version routing between v2 and v3 APIs.

Example

// Basic usage
const client = new NDExClient({
  baseURL: 'https://www.ndexbio.org',
  debug: true
});

// Authenticate (requires auth config in constructor)
const user = await client.user.authenticate();

// Search networks
const results = await client.networks.searchNetworks({ searchString: 'pathway' });

// Get network as CX2
const network = await client.networks.getRawCX2Network('network-uuid');

// User operations
const profile = await client.user.getCurrentUser();

// Admin operations (requires admin privileges)
const stats = await client.admin.getSystemStats();

Index

Constructors

constructor

new NDExClient(config?: NDExClientConfig): NDExClient
Parameters
- config: NDExClientConfig = {}
Returns NDExClient
- Defined in index.ts:95

Properties

`Readonly`networks

networks: UnifiedNetworkService

Network operations with intelligent v2/v3 routing

`Readonly`files

files: FilesService

File upload/download and task management

`Readonly`workspace

workspace: WorkspaceService

Workspace operations (deprecated - most functionality moved to other services)

`Readonly`user

user: UserService

User authentication and management

`Readonly`admin

admin: AdminService

System administration operations

Accessors

v2

get v2(): { networks: NetworkServiceV2 }
Access to version-specific network services for advanced usage

Returns { networks: NetworkServiceV2 }
- Defined in index.ts:202

v3

get v3(): { networks: NetworkServiceV3 }
Returns { networks: NetworkServiceV3 }
- Defined in index.ts:208

Methods

logout

logout(): void
Clear authentication

Returns void
- Defined in index.ts:108

getServerStatus

getServerStatus(
    format?: "full",
): Promise<
    {
        message: string;
        properties?: {
            ServerVersion: string;
            Build: string;
            ServerResultLimit: string;
            ImporterExporters: {
                importer: boolean;
                exporter: boolean;
                fileExtension: string;
                name: string;
                description: string;
            }[];
        };
        networkCount: number;
        userCount: number;
        groupCount?: number;
    },
>
Get server status information Can be called by authenticated or anonymous users.
Parameters
- Optionalformat: "full"
  Optional format parameter. Use 'full' for detailed information including properties and importers/exporters
Returns Promise<
    {
        message: string;
        properties?: {
            ServerVersion: string;
            Build: string;
            ServerResultLimit: string;
            ImporterExporters: {
                importer: boolean;
                exporter: boolean;
                fileExtension: string;
                name: string;
                description: string;
            }[];
        };
        networkCount: number;
        userCount: number;
        groupCount?: number;
    },
>
Server status including network/user counts and optional server details
- Defined in index.ts:118

hasAuthInfo

hasAuthInfo(): boolean
Check if client has valid authentication information configured

Returns boolean
true if auth is a valid BasicAuth or OAuthAuth object, false otherwise
- Defined in index.ts:149

updateConfig

updateConfig(config: Partial<NDExClientConfig>): void
Update client configuration
Parameters
- config: Partial<NDExClientConfig>
Returns void
- Defined in index.ts:169

getConfig

getConfig(): NDExClientConfig
Get current client configuration

Returns NDExClientConfig
- Defined in index.ts:176

getAuthType

getAuthType(): undefined | AuthType
Get current authentication type

Returns undefined | AuthType
The type of authentication configured (AuthType), or undefined if no auth is configured
- Defined in index.ts:184

setIdToken

setIdToken(idToken: string): void
Set ID token for OAuth authentication Creates OAuth auth configuration if no auth is currently configured
Parameters
- idToken: string
  The ID token to set
Returns void
- Defined in index.ts:193

Class NDExClient

Example

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NDExClient

Properties

Readonlynetworks

Readonlyfiles

Readonlyworkspace

Readonlyuser

Readonlyadmin

Accessors

v2

Returns { networks: NetworkServiceV2 }

v3

Returns { networks: NetworkServiceV3 }

Methods

logout

Returns void

getServerStatus

Parameters

hasAuthInfo

Returns boolean

updateConfig

Parameters

Returns void

getConfig

Returns NDExClientConfig

getAuthType

Returns undefined | AuthType

setIdToken

Parameters

Returns void

Settings

On This Page

`Readonly`networks

`Readonly`files

`Readonly`workspace

`Readonly`user

`Readonly`admin