Typescript support

[PhilThurston]

Are there any plans to provide type definitions for typescript? It is one of the key things preventing us from making the move from python.

[kamilgregorczyk]

bump

[scrapoxy]

bump please!!!

[Clovel]

Bump.

P.S. : Is this project dead ?

[stouch]

This project looks dead.

In my case I did :

1. Create a ovh-client.d.ts file with something like :

declare module '@ovhcloud/node-ovh' {
  interface OvhOptions {
    appKey: string;
    appSecret: string;
    consumerKey: string;
    endpoint?: string;
    [key: string]: any;
  }

  interface OvhClient {
    request<T = any>(
      method: string,
      path: string,
      params?: Record<string, any>,
      body?: Record<string, any>,
    ): Promise<T>;

    requestPromised<T = any>(
      method: string,
      path: string,
      params?: Record<string, any>,
      body?: Record<string, any>,
    ): Promise<T>;
  }

  function ovh(options: OvhOptions): OvhClient;

  export = ovh;
}

2. Then you can :

import OVH from '@ovhcloud/node-ovh';

const ovhClient = OVH({
    appKey: config.OVH_APP_KEY,
    appSecret: config.OVH_APP_SECRET,
    consumerKey: config.OVH_CONSUMER_KEY,
});

[rbeuque74]

Hello guys,
Sorry for the long answer.

Project is not dead technically speaking, OVHcloud is still engaged to maintain this project.
But we are not have any plans to support type definitions for typescript.

If community is willing to contribute to improve this, we will be ok to move forward then.

Romain

[Clovel]

I'm sorry @rbeuque74 but in 2025, saying that there are no plans for TypeScript support (real TypeScript or JSDoc) is admitting the project isn't taken seriously.

The absence of real usage documentation, parameter and return type descriptions or pagination examples other than what the OVH API Console provides (which is terrible btw) makes this library terribly painful to use.

I've used this library for years and and it hasn't really changed except for a package name change.

[rbeuque74]

Hello @Clovel,

I understand your frustration. We can agree that we can't call this repository "active", as the contribution are not frequent, and limit themselves as matching the features coverage of our others libraries in the different languages we support.
But I would not say that we are not taking this seriously: to be transparent with you, the team behind this repository is a backend team, and Javascript/Typescript are not our predilection programming languages. The level of maintenance we commit to is to make sure that current features are still working, and as far as I know, it is working.

We, at OVHcloud, are working hard at improving the developer experience: we improved the Terraform provider a lot lately, we have released the OAuth2 authentication to get ride of our "proprietary" authentication mechanism (which, by the way, means that this library handling the authentication could be replaced by any library with OAuth2 support), we published our new API Console that supports OpenAPI3 format (which make our API compatible with any tool handling OpenAPI format).
Next month, we will announce new huge improvements on the developer experience as well.
That being said, indeed, adding typescript support inside node-ovh is not our top priority for the moment :/

We would be delighted if the community is willing to contribute with us to make this repository more 2025 as you said.

the OVH API Console provides (which is terrible btw)

If you have feedback regarding this, we are also open to receive it (maybe not here to avoid off-topic), but could be in a new issue or discussions or on our API mailing-list (api-subscribe@ml.ovh.net to subscribe, then api@ml.ovh.net to post)

Romain