codegenapi

Documentation

Index

• Constants
• func GraphQLName(cfg Config, name string) string
• type Config
• type DummyConfig
  • func (cfg *DummyConfig) DebugMode() bool
  • func (cfg *DummyConfig) DefaultGraphQLFieldFormat() GraphQLFieldFormat
  • func (cfg *DummyConfig) DefaultGraphQLMutationName() GraphQLMutationName
  • func (cfg DummyConfig) DummyWrite() bool
  • func (cfg DummyConfig) FieldPrivacyEvaluated() FieldPrivacyEvaluated
  • func (cfg *DummyConfig) GetRootPathToConfigs() string
  • func (cfg DummyConfig) GetTemplatizedViewer() *ViewerConfig
• type FieldPrivacyEvaluated
• type GraphQLFieldFormat
• type GraphQLMutationName
• type ViewerConfig
  • func (cfg *ViewerConfig) Clone() *ViewerConfig
  • func (cfg *ViewerConfig) GetImport() string
  • func (cfg *ViewerConfig) GetImportPath() *tsimport.ImportPath

Constants

const DefaultGraphQLMutationName = NounVerb

Functions

func GraphQLName

func GraphQLName(cfg Config, name string) string

Types

type Config

type Config interface {
	DefaultGraphQLMutationName() GraphQLMutationName
	DefaultGraphQLFieldFormat() GraphQLFieldFormat
	FieldPrivacyEvaluated() FieldPrivacyEvaluated
	GetRootPathToConfigs() string
	DebugMode() bool
	// doesn't actually writes the files, just keeps track of which files were going to be written
	// used to detect dangling files...
	DummyWrite() bool
	GetTemplatizedViewer() *ViewerConfig
}

this file exists to simplify circular dependencies

type DummyConfig

type DummyConfig struct {
}

DummyConfig exists for tests/legacy paths which need Configs and don't want to create the production one

func (*DummyConfig) DebugMode

func (cfg *DummyConfig) DebugMode() bool

func (*DummyConfig) DefaultGraphQLFieldFormat

func (cfg *DummyConfig) DefaultGraphQLFieldFormat() GraphQLFieldFormat

func (*DummyConfig) DefaultGraphQLMutationName

func (cfg *DummyConfig) DefaultGraphQLMutationName() GraphQLMutationName

func (DummyConfig) DummyWrite

func (cfg DummyConfig) DummyWrite() bool

func (DummyConfig) FieldPrivacyEvaluated

func (cfg DummyConfig) FieldPrivacyEvaluated() FieldPrivacyEvaluated

func (*DummyConfig) GetRootPathToConfigs

func (cfg *DummyConfig) GetRootPathToConfigs() string

func (DummyConfig) GetTemplatizedViewer

func (cfg DummyConfig) GetTemplatizedViewer() *ViewerConfig

type FieldPrivacyEvaluated

type FieldPrivacyEvaluated string

const (
	AtEntLoad FieldPrivacyEvaluated = "at_ent_load"
	OnDemand  FieldPrivacyEvaluated = "on_demand"
)

type GraphQLFieldFormat

type GraphQLFieldFormat string

const (
	LowerCamelCase GraphQLFieldFormat = "lowerCamel"

	SnakeCase GraphQLFieldFormat = "snake_case"
)

type GraphQLMutationName

type GraphQLMutationName string

const (
	// e.g. userCreate. default
	NounVerb GraphQLMutationName = "NounVerb"

	// e.g. createUser
	VerbNoun GraphQLMutationName = "VerbNoun"
)

type ViewerConfig

type ViewerConfig struct {
	Path  string `yaml:"path"`
	Name  string `yaml:"name"`
	Alias string `yaml:"alias"`
}

func (*ViewerConfig) Clone

func (cfg *ViewerConfig) Clone() *ViewerConfig

func (*ViewerConfig) GetImport

func (cfg *ViewerConfig) GetImport() string

func (*ViewerConfig) GetImportPath

func (cfg *ViewerConfig) GetImportPath() *tsimport.ImportPath