snyk-data v3.1.0

snyk-data

Application data layer for interacting with the Snyk API

Exports the interface, class, and models for the following Snyk API features:

• Projects

  • ListProjects

Coding Example

import { ISnykProjectsDatasource, SnykProjectsDatasource, ListProjectsResponse } from 'snyk-data';

const projectDatasource: ISnykProjectsDatasource = new SnykProjectsDatasource();

const projects: ListProjectsResponse = await projectDatasource.listProject('<Snyk OrgId>')

Dependency Injection

Easily mock a Datasource to test your own code

// A mocked API response to decouple your application from the datasource
import mockResponse from './mocks/list_projects.json';
import { ISnykProjectsDatasource, ListProjectsResponse } from 'snyk-data';

class MockSnykProjectsDatasource implements ISnykProjectsDatasource {
  async listProjects(orgId: string): Promise<ListProjectsResponse> {
    const projects: ListProjectsResponse = mockResponse;
    
    return projects;
  }
}

it('should return the mocked response', async () => {
  const datasource = new MockSnykProjectsDatasource();
  const expected: ListProjectsResponse = mockResponse;
  const got = await datasource.listProjects('<Snyk OrgId>');
  
  expect(got).toEqual(expected)
})