sdk/effect/getVersionFromNPM

Classes

GetVersionFromNPM

Defined in: studiocms/packages/studiocms/src/sdk/effect/getVersionFromNPM.ts:34^

An Effect service for retrieving the version of an NPM package from the NPM registry.

Remarks

This service uses an HTTP client with retry logic to fetch the version information for a given package and version (defaulting to ‘latest’) from the NPM registry.

Example

const version = await GetVersionFromNPM.get('react');

Service

• Depends on FetchHttpClient.layer for HTTP requests.

Method

get

Param

The name of the NPM package.

Param

The version tag or number (defaults to ‘latest’).

Extends

• any

Constructors

Constructor

new GetVersionFromNPM(): GetVersionFromNPM

Returns

GetVersionFromNPM

Inherited from

Effect.Service<GetVersionFromNPM>()(
  'studiocms/sdk/effect/GetVersionFromNPM',
  {
    effect: Effect.gen(function () {
      const httpClient = (yield HttpClient.HttpClient).pipe(
        HttpClient.retryTransient({
          times: 3,
          schedule: Schedule.spaced('1 second'),
        })
      );

      /
        Retrieves the version of an NPM package.

        @param pkg - The name of the NPM package.
        @param ver - The version tag or number (defaults to 'latest').
        @returns An Effect that resolves to the version string of the specified package.
       /
      const get = (pkg: string, ver = 'latest') =>
        Effect.gen(function () {
          const response = yield httpClient
            .get(https://registry.npmjs.org/${pkg}/${ver})
            .pipe(Effect.flatMap(HttpClientResponse.schemaBodyJson(NpmVersion)));
          return response.version;
        });

      return { get };
    }),
    dependencies: [FetchHttpClient.layer],
  }
).constructor

---

NpmVersion

Defined in: studiocms/packages/studiocms/src/sdk/effect/getVersionFromNPM.ts:10^

Represents the version information retrieved from NPM.

Extends

• any

Constructors

Constructor

new NpmVersion(): NpmVersion

Returns

NpmVersion

Inherited from

Schema.Class<NpmVersion>('NpmVersion')({
  version: Schema.String,
}).constructor