Documentation ¶
Index ¶
- type Config
- type Instance
- type MockInstance
- func (_m *MockInstance) GetFile(ctx context.Context, service string, path string) ([]byte, error)
- func (_m *MockInstance) GetIndex(ctx context.Context, service string) (*shared.Index, error)
- func (_m *MockInstance) GetIndexes(ctx context.Context) ([]shared.Index, error)
- func (_m *MockInstance) GetMarkdown(ctx context.Context, service string, path string) (*shared.Markdown, error)
- func (_m *MockInstance) GetName() string
- type NewMockInstanceT
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Instance ¶
type Instance interface { GetName() string GetIndexes(ctx context.Context) ([]shared.Index, error) GetIndex(ctx context.Context, service string) (*shared.Index, error) GetMarkdown(ctx context.Context, service, path string) (*shared.Markdown, error) GetFile(ctx context.Context, service, path string) ([]byte, error) }
Instance is the interface which must be implemented by each TechDocs instance.
type MockInstance ¶
MockInstance is an autogenerated mock type for the Instance type
func NewMockInstance ¶
func NewMockInstance(t NewMockInstanceT) *MockInstance
NewMockInstance creates a new instance of MockInstance. It also registers a testing interface on the mock and a cleanup function to assert the mocks expectations.
func (*MockInstance) GetFile ¶
GetFile provides a mock function with given fields: ctx, service, path
func (*MockInstance) GetIndexes ¶
GetIndexes provides a mock function with given fields: ctx
func (*MockInstance) GetMarkdown ¶
func (_m *MockInstance) GetMarkdown(ctx context.Context, service string, path string) (*shared.Markdown, error)
GetMarkdown provides a mock function with given fields: ctx, service, path
func (*MockInstance) GetName ¶
func (_m *MockInstance) GetName() string
GetName provides a mock function with given fields:
type NewMockInstanceT ¶
Click to show internal directories.
Click to hide internal directories.