# @lukekaalim/terraform-service

> An implementation of a Terraform Plugin GRPC service

Latest version **2.0.1** (published 2021-01-12) · MIT license · 0 weekly downloads

## Install

```sh
npm install @lukekaalim/terraform-service
pnpm add @lukekaalim/terraform-service
yarn add @lukekaalim/terraform-service
bun add @lukekaalim/terraform-service
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.1 |
| Published | 2021-01-12 |
| First published | 2021-01-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 3 |
| Unpacked size | 23.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| Author | Luke Kaalim |
| Maintainers | lukekaalim |

## Links

- npm: https://www.npmjs.com/package/@lukekaalim/terraform-service
- npm.io page: https://npm.io/package/@lukekaalim/terraform-service

## Dependencies (3)

- [msgpack-lite](https://npm.io/package/msgpack-lite.md) ^0.1.26
- [@grpc/grpc-js](https://npm.io/package/@grpc/grpc-js.md) ^1.2.2
- [@grpc/proto-loader](https://npm.io/package/@grpc/proto-loader.md) ^0.5.5

## Recent versions

- 2.0.1 (latest) — 2021-01-12
- 2.0.0 — 2021-01-11
- 1.0.1 — 2021-01-04
- 1.0.0 — 2021-01-03

## README

---
title: "@lukekaalim/terraform-service"
layout: default
parent: Packages
nav_order: 6
---
# `@lukekaalim/terraform-service`

Provides a bare-bones implementation of the Terraform GRPC service. Use with `@lukekaalim/hashicorp-go-plugin` to create a terraform plugin.

## Installation
```bash
npm install @lukekaalim/terraform-service
```
## API
### `createTerraformService()`
```js
const { createTerraformService } = require('@lukekaalim/terraform-service');

const options = {
  getSchema,
};

const service = createTerraformService(
  console,        // Console
  server,         // Server
  options,        // ServiceOptions
);
const {
  definition,     // GRPCServiceDefinition
  implementation, // GRPCServiceImplementation
} = service;
```

```ts
const getSchema = async () => ({
  provider,           // Schema
  resourceSchemas,    // { [string]: Schema }
  dataSourceSchemas,  // { [string]: Schema }
  diagnostics,        // Diagnostic[] 
});
```

### `getDynamicValue()`
### `setPackedDynamicValue()`
### `setJSONDynamicValue()`
### `new Unknown()`

## TODO
  -  Finish API documentation

---
_Source: https://npm.io/package/@lukekaalim/terraform-service · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._