swoody v0.2.0

Swoody ·

Powerfull JSON Generator

• Complete documentation
• Quick example

Quick Example

Try out the following code and realise the power of Swoody 😎

import { generate } from 'swoody'

const eventsSchema = {
  repeat: 7,
  object: {
    id: '{{ faker.random.uuid() }}',
    isOnline: '{{ faker.random.boolean() }}',
    description: '{{ faker.lorem.paragraphs(2) }}',
    when: '{{ moment() }}',
    place({ faker }) {
      const cities = ['New-York', 'Moscow', 'Tokyo']
      return faker.random.arrayElement(cities)
    },
    organizators: {
      repeat: [1, 5],
      object: {
        name: '{{ faker.name.firstName() }} {{ faker.name.lastName() }}',
        job: '{{ faker.name.jobTitle() }}',
        email: '{{ faker.internet.email() }}',
        avatar: '{{ faker.internet.avatar() }}',
        age: '{{ 10 + 8 }}',
      },
    },
  },
}

const json = generate(eventsSchema) // random generated json data

console.log(json)

Documentation

• Generating arrays
• Generating static values
• Special schema values
• Build in Context
• Custom Context

Arrays

object field is using for defining value of element of array

repeat field is using for defining exact or ramdom in range length of array:

This will generate array of exact length

const schema = {
  repeat: 7, // exact length
  object: '{{ faker.random.number() }}',
}

This will generate array of random length in range from 1 to 5

const schema = {
  repeat: [2, 8], // ramdom in range from 2 to 8
  object: '{{ faker.random.number() }}',
}

Static values

To get a static values just pass them and left alone (-_-):

const schema =  {
  str: 'some string',
  num: 1923,
  nil: null,
  bool: false,
  parent: {
    isChild: true
    child: {
      otherNestedProp: 'kek'
    }
  }
}

And exceptions...

All the following values below will be evaluated to null

const schema = {
  prop0: null,
  prop1: undefined,
  prop2: NaN,
  prop3: Infinity,
  prop4: -Infinity,
  prop5: () => console.log,
  prop6() {},
}

Special schema values

evaluating function props

This function value will be evaluated to returned value from return statement:

const schema = {
  funcProp(context) {
    return 20 % faker.random.number()
  },
}

And function which return nothing will be evaluated to null:

const schema = {
  funcProp(context) {
    console.log(context)
  },
}

evaluating string and mustaches props

Any expresion inside mustaches {{ }} will be evaluated and returned in field.

This will evaluate expression inside mustache:

const schema = {
  num: '{{ faker.random.number() }}',
  string: 'number: {{ 2 + 4 }}',
}

You also have a context in mustaches and mustaches

const schema = {
  mustacheContext: '{{ faker.random.number() }}',
  functionContext(context) {
    return context.faker.random.number()
  },
}

Build in context

Soon...

Custom Context

You can pass your own context as a second argument in generate and handleField:

import { generate, handleField } from 'swoody'

const customContext = {
  MATH_PI: 3.14159,
  cities: ['New-York', 'Moscow', 'Tokyo'],
  trimString(string) {
    return string.trim()
  },
}

const schema = {
  repeat: 7,
  object: {
    radius: '{{ MATH_PI * 2 }}',
    place(context) {
      return context.faker.random.arrayElement(context.cities)
    },
    str(context) {
      return context.trimString('   fdkasfj   ')
    },
  },
}

// pass customContext
const jsObject = handleField(eventsSchema, customContext)
const jsonData = generate(eventsSchema, customContext)

console.log(jsObject)
console.log(jsonData)