大数据安全>> alien>> 返回
项目作者： natepisarski

项目描述 ：
Create a fully configurable fluent interface to your DTO
高级语言： JavaScript
项目地址: git://github.com/natepisarski/alien.git
创建时间： 2018-02-03T06:20:08Z
项目社区：https://github.com/natepisarski/alien
开源协议：MIT License
下载


alien version 0.1.0

Before I bore you with use-cases and details, look at these few examples:

Basic Usage

  1. ℿ(['name', 'email']).setName('Nathaniel').setEmail('Nathaniel@website.com')

Configuring Output

  1. ℿ(['name'], {c: {s: t => `_${t}`}})._name("Nathaniel")

Advanced Settings

  1. const schema = ℿ(['SSN'], {ob: true}).schema

What is alien?

Alien (invoked via alien() or ℿ) is a system for building cascadable object factories. You define the properties of your object,
and it generates a fluent interface that allows the caller to chain set commands. So, instead of:

  1. myObject.prop1 = "Hey"
  2. myObject.prop2 = "There"

you get:

  1. myObject.setProp1("Hey").setProp2("There")

This is supposed to streamline your data-transfer objects.

Frankly, this design pattern is horrible for real code! This package is very much a “because it was fun to write” sort of thing. In that same spirit, 2 more design goals were accomplished here:

  • EVERYTHING is configurable
  • Code Golf support is included

Absolutely Everything is Configurable

Let’s say you don’t like set[Property] as the property syntax. You can pass in the setterTransformer
property to change it to _[Property], or changeTheValueOf[Property]To, or whatever you want. It’s all up to the caller.

You can configure:

  • Whether or not to keep unset variables (finalization.removeUnused)
  • Whether or not to remove the setters (finalization.removeSetters)
  • Whether or not to build a schema (objectUtilities.schema) (you always want this unless memory usage is a gigantic concern)
  • Whether or not to add a .reset() that blanks the properties (objectUtilities.reset)
  • How to name the properties (control.nameTransformer)
  • How to name the setters (control.setterTransformer)
  • Whether or not to add a .set({prop: 'val'}) interface (control.setObjects)
  • Whether you start with properties which are undefined or simply don’t add them (control.createBlankProperty)
  • What to do when the object begins building (advanced.startAction)
  • What to do when the object is about to be done building (advanced.finalAction)
  • What to do every time a property is processed (when it’s making the setters) (advanced.stepAction)
  • Whether or not to override the schema step and use “unsafe validation” (advanced.allowUnsafeInitialization)

Code Golf Shenanigans

Any of the options are configurable with the least amount of characters to uniqueled identify the setting… (what?)

So, control.nameTransformer can be set with {c: {n" true}} (c = control, n = nameTransformer)

This is called a fast-option in the code. In theory, it could reduce the total amount of code transmitted to a client. With that said, if it reduces your file-size in practice, something goofy is going on in your codebase!

Warning: Semver not affected from fast-option breakages

Since I can’t know what fast-option‘s are being used, if a change is made that may break your fast-option, it will not bump the major semver version. Be careful! In many cases, it’s safer to use the camel-case-initialism match.

So, {c: {nT: ''}} for {control: {nameTransformer: ''}}