renderInterfaceProperty.test.ts

import renderInterfaceProperty from "../../../src/renderers/typescript/renderInterfaceProperty"

describe("renderInterfaceProperty()", () => {
  it("works with unrequired properties", () => {
    expect(renderInterfaceProperty("property", "type", false, false, false).trim()).toMatchInlineSnapshot(
      `"property?: type | undefined;"`,
    )
  })

  it("works with required properties", () => {
    expect(renderInterfaceProperty("property", "type", true, false, false).trim()).toMatchInlineSnapshot(
      `"property: type;"`,
    )
  })

  it("adds descriptions", () => {
    expect(renderInterfaceProperty("property", "type", false, false,  false,"Description").trim())
      .toMatchInlineSnapshot(`
      "/** Description */
      property?: type | undefined;"
    `)
  })

  it("supports localized fields", () => {
    expect(renderInterfaceProperty("property", "type", false, true, true).trim()).toMatchInlineSnapshot(
      `"property?: LocalizedField<type> | undefined;"`,
    )

    expect(renderInterfaceProperty("property", "type", false, true, false).trim()).toMatchInlineSnapshot(
      `"property?: DefaultLocalizedField<type> | undefined;"`,
    )
  })
})